Tizen Native API  5.5
Ecore Timer functions

Ecore provides very flexible timer functionality. The basic usage of timers, to call a certain function at a certain interval can be achieved with a single line:

 Eina_Bool my_func(void *data) {
    do_funky_stuff_with_data(data);
    return ECORE_CALLBACK_RENEW;
 }
 ecore_timer_add(interval_in_seconds, my_func, data_given_to_function);
Note:
If the function was to be executed only once simply return ECORE_CALLBACK_CANCEL instead.

An example that shows the usage of a lot of these:

Functions

double ecore_timer_precision_get (void)
void ecore_timer_precision_set (double precision)
 Sets the precision to be used by timer infrastructure.
char * ecore_timer_dump (void)
void ecore_timer_interval_set (Efl_Loop_Timer *obj, double in)
 Interval the timer ticks on.
double ecore_timer_interval_get (const Efl_Loop_Timer *obj)
 Interval the timer ticks on.
double ecore_timer_pending_get (const Efl_Loop_Timer *obj)
 Pending time regarding a timer.
void ecore_timer_reset (Efl_Loop_Timer *obj)
 Resets a timer to its full interval. This effectively makes the timer start ticking off from zero now.
void ecore_timer_delay (Efl_Loop_Timer *obj, double add)
 Adds a delay to the next occurrence of a timer. This doesn't affect the timer interval.

Typedefs

typedef Eo Ecore_Timer

Typedef Documentation

typedef Eo Ecore_Timer

A handle for timers


Function Documentation

Ecore_Timer* ecore_timer_add ( double  in,
Ecore_Task_Cb  func,
const void *  data 
)

Creates a timer to call the given function in the given period of time.

Parameters:
inThe interval in seconds.
funcThe given function. If func returns 1, the timer is rescheduled for the next interval in.
dataData to pass to func when it is called.
Returns:
A timer object on success, NULL on failure.

This function adds a timer and returns its handle on success and NULL on failure. The function func will be called every in seconds. The function will be passed the data pointer as its parameter.

When the timer func is called, it must return a value of either 1 (or ECORE_CALLBACK_RENEW) or 0 (or ECORE_CALLBACK_CANCEL). If it returns 1, it will be called again at the next tick, or if it returns 0 it will be deleted automatically making any references/handles for it invalid.

Since :
2.3.1
Examples:
ecore_animator_example.c, ecore_exe_example.c, ecore_fd_handler_example.c, ecore_idler_example.c, ecore_thread_example.c, ecore_time_functions_example.c, ecore_timer_example.c, eina_tiler_01.c, evas-events.c, inwin_example.c, map_example_01.c, map_example_02.c, map_example_03.c, prefs_example_01.c, prefs_example_02.c, and progressbar_example.c.
void* ecore_timer_del ( Ecore_Timer timer)

Deletes the specified timer from the timer list.

Parameters:
timerThe timer to delete.
Returns:
The data pointer set for the timer when ecore_timer_add was called. NULL is returned if the function is unsuccessful.

Note: timer must be a valid handle. If the timer function has already returned 0, the handle is no longer valid (and does not need to be delete).

Since :
2.3.1
Examples:
ecore_fd_handler_example.c, ecore_idler_example.c, ecore_timer_example.c, evas-events.c, and progressbar_example.c.
void ecore_timer_delay ( Efl_Loop_Timer *  obj,
double  add 
)

Adds a delay to the next occurrence of a timer. This doesn't affect the timer interval.

This effectively resets a timer but based on the time when this iteration of the main loop started.

Since (EFL) :
1.18
Parameters:
[in]objThe object.
[in]addThe amount of time by which to delay the timer in seconds
Since :
2.3.1
Examples:
ecore_timer_example.c.
char* ecore_timer_dump ( void  )

This function returns a human readable text-based log for Ecore_Timer events.

Returns:
A heap allocated string, or NULL. It MUST be freed manually by the caller using `free`.

It only contains an useful implementation if EFL is built in debug build profile, but it's safe to call it for any build profile.

Since :
2.3.1
void ecore_timer_freeze ( Ecore_Timer timer)

Pauses a running timer.

Parameters:
timerThe timer to be paused.
Remarks:
The timer callback won't be called while the timer is paused. The remaining time until the timer expires will be saved, so the timer can be resumed with that same remaining time to expire, instead of expiring instantly. Use ecore_timer_thaw() to resume it.
Note:
Nothing happens if the timer was already paused.
See also:
ecore_timer_thaw()
Since :
2.3.1
Examples:
ecore_timer_example.c.

Return whether the timer is freezing.

Since :
3.0
Returns:
True if the timer object is freezed, false otherwise.
See also:
ecore_timer_freeze(), ecore_timer_thaw()
double ecore_timer_interval_get ( const Efl_Loop_Timer *  obj)

Interval the timer ticks on.

Parameters:
[in]objThe object.
Returns:
The new interval in seconds
Since :
2.3.1
Examples:
ecore_timer_example.c.
void ecore_timer_interval_set ( Efl_Loop_Timer *  obj,
double  in 
)

Interval the timer ticks on.

If set during a timer call this will affect the next interval.

Parameters:
[in]objThe object.
[in]inThe new interval in seconds
Since :
2.3.1
Examples:
ecore_timer_example.c.
Ecore_Timer* ecore_timer_loop_add ( double  in,
Ecore_Task_Cb  func,
const void *  data 
)

Creates a timer to call the given function in the given period of time.

Parameters:
inThe interval in seconds from current loop time.
funcThe given function. If func returns 1, the timer is rescheduled for the next interval in.
dataData to pass to func when it is called.
Returns:
A timer object on success, NULL on failure.

This is the same as ecore_timer_add(), but "now" is the time from ecore_loop_time_get() not ecore_time_get() as ecore_timer_add() uses. See ecore_timer_add() for more details.

Since :
2.3.1
double ecore_timer_pending_get ( const Efl_Loop_Timer *  obj)

Pending time regarding a timer.

Parameters:
[in]objThe object.
Returns:
Pending time
Since :
2.3.1
Examples:
ecore_timer_example.c.
double ecore_timer_precision_get ( void  )

Retrieves the current precision used by timer infrastructure.

Returns:
Current precision.
See also:
ecore_timer_precision_set()
Since :
2.3.1
void ecore_timer_precision_set ( double  precision)

Sets the precision to be used by timer infrastructure.

Parameters:
precisionAllowed introduced timeout delay, in seconds.

This sets the precision for all timers. The precision determines how much of an difference from the requested interval is acceptable. One common reason to use this function is to increase the allowed timeout and thus decrease precision of the timers, this is because less precise the timers result in the system waking up less often and thus consuming less resources.

Be aware that kernel may delay delivery even further, these delays are always possible due other tasks having higher priorities or other scheduler policies.

Example: We have 2 timers, one that expires in a 2.0s and another that expires in 2.1s, if precision is 0.1s, then the Ecore will request for the next expire to happen in 2.1s and not 2.0s and another one of 0.1 as it would before.

Note:
Ecore is smart enough to see if there are timers in the precision range, if it does not, in our example if no second timer in (T + precision) existed, then it would use the minimum timeout.
Since :
2.3.1
Examples:
ecore_timer_example.c.
void ecore_timer_reset ( Efl_Loop_Timer *  obj)

Resets a timer to its full interval. This effectively makes the timer start ticking off from zero now.

This is equal to delaying the timer by the already passed time, since the timer started ticking

Parameters:
[in]objThe object.
Since (EFL) :
1.2
Since :
2.3.1
void ecore_timer_thaw ( Ecore_Timer timer)

Resumes a frozen (paused) timer.

Since :
2.3.1
Remarks:
The timer will be resumed from its previous relative position in time. That means, if it had X seconds remaining until expire when it was paused, it will be started now with those same X seconds remaining to expire again. But notice that the interval time won't be touched by this call or by ecore_timer_freeze().
Parameters:
[in]timerThe timer to be resumed.
See also:
ecore_timer_freeze()
Examples:
ecore_timer_example.c.