d2/dd8/scheduler_8h_source.html

#ifndef __CWIST_SCHEDULER_H__

#define __CWIST_SCHEDULER_H__


#include <cwist/sys/io/cwist_io.h>

#include <stdbool.h>

#include <stdint.h>

#include <stddef.h>


#ifdef __cplusplus

extern "C" {

#endif


typedef struct cwist_scheduler cwist_scheduler_t;


cwist_scheduler_t *cwist_scheduler_create(size_t worker_count, size_t queue_capacity);


void cwist_scheduler_destroy(cwist_scheduler_t *s);


bool cwist_scheduler_submit(cwist_scheduler_t *s, cwist_job_func func, void *arg);


bool cwist_scheduler_schedule(cwist_scheduler_t *s, cwist_job_func func, void *arg,

                              uint64_t delay_ms);


size_t cwist_scheduler_pending_count(cwist_scheduler_t *s);


typedef void (*cwist_scheduler_drop_cb)(void *arg);


size_t cwist_scheduler_cancel_pending(cwist_scheduler_t *s,

                                      cwist_scheduler_drop_cb drop_cb);


#ifdef __cplusplus

}

#endif


#endif /* __CWIST_SCHEDULER_H__ */

cwist_io.h
Platform Agnostic Async Job Queue Interface.

cwist_job_func
void(* cwist_job_func)(void *arg)
Job function signature.
Definition cwist_io.h:22

cwist_scheduler_destroy
void cwist_scheduler_destroy(cwist_scheduler_t *s)
Destroy the scheduler and stop all worker threads.
Definition scheduler.c:327

cwist_scheduler_submit
bool cwist_scheduler_submit(cwist_scheduler_t *s, cwist_job_func func, void *arg)
Submit a job to be executed as soon as a worker is available.
Definition scheduler.c:360

cwist_scheduler_t
struct cwist_scheduler cwist_scheduler_t
Opaque background job scheduler handle.
Definition scheduler.h:21

cwist_scheduler_schedule
bool cwist_scheduler_schedule(cwist_scheduler_t *s, cwist_job_func func, void *arg, uint64_t delay_ms)
Schedule a job to run after a relative delay.
Definition scheduler.c:380

cwist_scheduler_pending_count
size_t cwist_scheduler_pending_count(cwist_scheduler_t *s)
Number of delayed jobs currently waiting to fire.
Definition scheduler.c:412

cwist_scheduler_cancel_pending
size_t cwist_scheduler_cancel_pending(cwist_scheduler_t *s, cwist_scheduler_drop_cb drop_cb)
Cancel all delayed jobs that have not yet fired.
Definition scheduler.c:429

cwist_scheduler_create
cwist_scheduler_t * cwist_scheduler_create(size_t worker_count, size_t queue_capacity)
Create a scheduler with a pool of background workers.
Definition scheduler.c:265

cwist_scheduler_drop_cb
void(* cwist_scheduler_drop_cb)(void *arg)
Callback invoked for each pending job that is cancelled.
Definition scheduler.h:65