Idle_Group (3) - Linux Manuals

Idle_Group: Callbacks that are called when the program enters or exits an idle state.

NAME

Idle Handlers - Callbacks that are called when the program enters or exits an idle state.

Functions

EAPI Ecore_Idle_Enterer * ecore_idle_enterer_add (int(*func)(void *data), const void *data)
Add an idle enterer handler.
EAPI Ecore_Idle_Enterer * ecore_idle_enterer_before_add (int(*func)(void *data), const void *data)
Add an idle enterer handler at the start of the list so it gets called earlier than others.
EAPI void * ecore_idle_enterer_del (Ecore_Idle_Enterer *idle_enterer)
Delete an idle enterer callback.
EAPI Ecore_Idle_Exiter * ecore_idle_exiter_add (int(*func)(void *data), const void *data)
Add an idle exiter handler.
EAPI 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.
EAPI Ecore_Idler * ecore_idler_add (int(*func)(void *data), const void *data)
Add an idler handler.
EAPI void * ecore_idler_del (Ecore_Idler *idler)
Delete an idler callback from the list to be executed.

Detailed Description

Callbacks that are called when the program enters or exits an idle state.

The ecore main loop enters an idle state when it is waiting for timers to time out, data to come in on a file descriptor or any other event to occur. You can set callbacks to be called when the main loop enters an idle state, during an idle state or just after the program wakes up.

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.

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.

Exiter callbacks are called when the main loop wakes up from an idle state.

Function Documentation

EAPI Ecore_Idle_Enterer* ecore_idle_enterer_add (int(*)(void *data) func, const void * data)

Add an idle enterer handler.

Parameters:

func The function to call when entering an idle state.
data The data to be passed to the func call

Returns:

A handle to the idle enterer callback if successful. Otherwise, NULL is returned.

EAPI Ecore_Idle_Enterer* ecore_idle_enterer_before_add (int(*)(void *data) func, const void * data)

Add an idle enterer handler at the start of the list so it gets called earlier than others.

Parameters:

func The function to call when entering an idle state.
data The data to be passed to the func call

Returns:

A handle to the idle enterer callback if successful. Otherwise, NULL is returned.

EAPI void* ecore_idle_enterer_del (Ecore_Idle_Enterer * idle_enterer)

Delete an idle enterer callback.

Parameters:

idle_enterer The idle enterer to delete

Returns:

The data pointer passed to the idler enterer callback on success. NULL otherwise.

EAPI Ecore_Idle_Exiter* ecore_idle_exiter_add (int(*)(void *data) func, const void * data)

Add an idle exiter handler.

Parameters:

func The function to call when exiting an idle state.
data The data to be passed to the func call

Returns:

A handle to the idle exiter callback on success. NULL otherwise.

EAPI 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.

Parameters:

idle_exiter The idle exiter to delete

Returns:

The data pointer that was being being passed to the handler if successful. NULL otherwise.

EAPI Ecore_Idler* ecore_idler_add (int(*)(void *data) func, const void * data)

Add an idler handler.

Parameters:

func The function to call when idling.
data The data to be passed to this func call.

Returns:

A idler handle if successfully added. 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.

EAPI void* ecore_idler_del (Ecore_Idler * idler)

Delete an idler callback from the list to be executed.

Parameters:

idler The handle of the idler callback to delete

Returns:

The data pointer passed to the idler callback on success. NULL otherwise.

Author

Generated automatically by Doxygen for Ecore from the source code.