The idler functionality in Ecore allows for callbacks to be called when the program isn't handling events, timers or fd handlers. More...
Typedefs | |
typedef Eo | Ecore_Idler |
A handle for idlers. | |
typedef Eo | Ecore_Idle_Enterer |
A handle for idle enterers. | |
typedef Eo | Ecore_Idle_Exiter |
A handle for idle exiters. | |
Ecore_Idler * | ecore_idler_add (Ecore_Task_Cb func, const void *data) |
Add an idler handler. More... | |
void * | ecore_idler_del (Ecore_Idler *idler) |
Delete an idler callback from the list to be executed. More... | |
Ecore_Idle_Enterer * | ecore_idle_enterer_add (Ecore_Task_Cb func, const void *data) |
Add an idle enterer handler. More... | |
Ecore_Idle_Enterer * | ecore_idle_enterer_before_add (Ecore_Task_Cb func, const void *data) |
Add an idle enterer handler at the start of the list so it gets called earlier than others. More... | |
void * | ecore_idle_enterer_del (Ecore_Idle_Enterer *idle_enterer) |
Delete an idle enterer callback. More... | |
Ecore_Idle_Exiter * | ecore_idle_exiter_add (Ecore_Task_Cb func, const void *data) |
Add an idle exiter handler. More... | |
void * | ecore_idle_exiter_del (Ecore_Idle_Exiter *idle_exiter) |
Delete an idle exiter handler from the list to be run on exiting idle state. More... | |
The idler functionality in Ecore allows for callbacks to be called when the program isn't handling events, timers or fd handlers.
There are three types of idlers: Enterers, Idlers(proper) and Exiters. They are called, respectively, when the program is about to enter an idle state, when the program is in an idle state and when the program has just left an idle state and will begin processing events, timers or fd handlers.
Enterer callbacks are good for updating your program's state, if it has a state engine. Once all of the enterer handlers are called, the program will enter a "sleeping" state.
Idler callbacks are called when the main loop has called all enterer handlers. They are useful for interfaces that require polling and timers would be too slow to use.
Exiter callbacks are called when the main loop wakes up from an idle state.
If no idler callbacks are specified, then the process literally goes to sleep. Otherwise, the idler callbacks are called continuously while the loop is "idle", using as much CPU as is available to the process.
Example with functions that deal with idle state:
Ecore_Idler* ecore_idler_add | ( | Ecore_Task_Cb | func, |
const void * | data | ||
) |
Add an idler handler.
func | The function to call when idling. |
data | The data to be passed to this func call. |
NULL
otherwise.Add an idler handle to the event loop, returning a handle on success and NULL
otherwise. The function func
will be called repeatedly while no other events are ready to be processed, as long as it returns 1
(or ECORE_CALLBACK_RENEW). A return of 0
(or ECORE_CALLBACK_CANCEL) deletes the idler.
Idlers are useful for progressively prossessing data without blocking.
References eo_add.
Referenced by eldbus_name_owner_changed_callback_add(), and eldbus_service_property_changed().
void* ecore_idler_del | ( | Ecore_Idler * | idler | ) |
Delete an idler callback from the list to be executed.
idler | The handle of the idler callback to delete |
NULL
otherwise. References EINA_MAIN_LOOP_CHECK_RETURN_VAL.
Referenced by eldbus_name_owner_changed_callback_del(), eldbus_service_object_manager_attach(), and ethumb_free().
Ecore_Idle_Enterer* ecore_idle_enterer_add | ( | Ecore_Task_Cb | func, |
const void * | data | ||
) |
Add an idle enterer handler.
func | The function to call when entering an idle state. |
data | The data to be passed to the func call |
References eo_add.
Referenced by ecore_evas_init(), ecore_wl_init(), and ecore_x_init().
Ecore_Idle_Enterer* ecore_idle_enterer_before_add | ( | Ecore_Task_Cb | func, |
const void * | data | ||
) |
Add an idle enterer handler at the start of the list so it gets called earlier than others.
func | The function to call when entering an idle state. |
data | The data to be passed to the func call |
References eo_add.
void* ecore_idle_enterer_del | ( | Ecore_Idle_Enterer * | idle_enterer | ) |
Delete an idle enterer callback.
idle_enterer | The idle enterer to delete |
References EINA_MAIN_LOOP_CHECK_RETURN_VAL.
Referenced by ecore_evas_shutdown().
Ecore_Idle_Exiter* ecore_idle_exiter_add | ( | Ecore_Task_Cb | func, |
const void * | data | ||
) |
Add an idle exiter handler.
func | The function to call when exiting an idle state. |
data | The data to be passed to the func call |
References eo_add.
void* ecore_idle_exiter_del | ( | Ecore_Idle_Exiter * | idle_exiter | ) |
Delete an idle exiter handler from the list to be run on exiting idle state.
idle_exiter | The idle exiter to delete |
References EINA_MAIN_LOOP_CHECK_RETURN_VAL.