celix_scheduled_event_options Struct Reference

Celix scheduled event options, used for creating scheduling events with the celix framework. More...

#include <celix_bundle_context.h>

Public Attributes
const char *name	CELIX_OPTS_INIT
	The name of the event, used for logging and debugging. More...
double initialDelayInSeconds	CELIX_OPTS_INIT
	Initial delay in seconds before the event is processed. More...
double intervalInSeconds	CELIX_OPTS_INIT
	Schedule interval in seconds. 0 means one-shot scheduled event. More...
void *callbackData	CELIX_OPTS_INIT
	Data passed to the callback function when a event is scheduled. More...
void(*	callback )(void *callbackData) CELIX_OPTS_INIT
	Callback function called to process a scheduled event. Will be called on the event thread. More...
void *removeCallbackData	CELIX_OPTS_INIT
	Data passed to the done callback function when a scheduled event is removed. More...
void(*	removeCallback )(void *removeCallbackData) CELIX_OPTS_INIT
	Callback function called when a scheduled event is removed. Will be called on the event thread. More...

Detailed Description

Celix scheduled event options, used for creating scheduling events with the celix framework.

Member Data Documentation

callback

void(* celix_scheduled_event_options::callback) (void *callbackData) CELIX_OPTS_INIT

Callback function called to process a scheduled event. Will be called on the event thread.

CELIX_OPTS_INIT [1/5]

const char* name celix_scheduled_event_options::CELIX_OPTS_INIT

The name of the event, used for logging and debugging.

Expected to be const char* that is valid during the celix_bundleContext_scheduleEvent call. Can be NULL.

CELIX_OPTS_INIT [2/5]

double initialDelayInSeconds celix_scheduled_event_options::CELIX_OPTS_INIT

Initial delay in seconds before the event is processed.

CELIX_OPTS_INIT [3/5]

double intervalInSeconds celix_scheduled_event_options::CELIX_OPTS_INIT

Schedule interval in seconds. 0 means one-shot scheduled event.

CELIX_OPTS_INIT [4/5]

void* callbackData celix_scheduled_event_options::CELIX_OPTS_INIT

Data passed to the callback function when a event is scheduled.

CELIX_OPTS_INIT [5/5]

void* removeCallbackData celix_scheduled_event_options::CELIX_OPTS_INIT

Data passed to the done callback function when a scheduled event is removed.

removeCallback

void(* celix_scheduled_event_options::removeCallback) (void *removeCallbackData) CELIX_OPTS_INIT

Callback function called when a scheduled event is removed. Will be called on the event thread.

---

The documentation for this struct was generated from the following file:

• libs/framework/include/celix_bundle_context.h