workqueue.h File Reference

#include "ove/types.h"
#include "ove/thread.h"
#include "ove_config.h"
#include "ove/storage.h"

Include dependency graph for workqueue.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef void(*	ove_work_fn) (ove_work_t work)
	Prototype for a work item handler function.

Functions
int	ove_workqueue_init (ove_workqueue_t *wq, ove_workqueue_storage_t *storage, const char *name, ove_prio_t priority, size_t stack_size, void *stack)
	Initialise a work queue using caller-provided static storage.
void	ove_workqueue_deinit (ove_workqueue_t wq)
	Deinitialise a statically-allocated work queue.
int	ove_work_init_static (ove_work_t *work, ove_work_storage_t *storage, ove_work_fn handler)
	Initialise a work item using caller-provided static storage.
int	ove_work_init (ove_work_t *work, ove_work_fn handler)
	Allocate and initialise a heap-backed work item.
void	ove_work_free (ove_work_t work)
	Free a heap-allocated work item.
int	ove_workqueue_create (ove_workqueue_t *wq, const char *name, ove_prio_t priority, size_t stack_size)
	Allocate a heap-backed work queue.
void	ove_workqueue_destroy (ove_workqueue_t wq)
	Destroy a heap-allocated work queue.
int	ove_work_submit (ove_workqueue_t wq, ove_work_t work)
	Submit a work item for immediate execution on the work queue.
int	ove_work_submit_delayed (ove_workqueue_t wq, ove_work_t work, uint32_t delay_ms)
	Submit a work item for execution after a delay.
int	ove_work_cancel (ove_work_t work)
	Cancel a pending work item before it executes.