Timer_q documentation -- constants

This is the value that static (Timer_q_base) structs need to be initialised to when in debugging mode.

In non-debugging mode this value is all 0's, so this won't do anything different from just declaring your structs as static.

The library will also re-initialise the base back to it's correct form before returning from timer_q_del_base, so you just need to set it up correctly the first time.

This is the value that static (Timer_q_node) structs need to be initialised to when in debugging mode.

In non-debugging mode this value is all 0's, so this won't do anything different from just declaring your structs as static.

The library will also re-initialise the node back to it's correct form before calling your call back (either for a delete or a run), so you just need to set it up correctly the first time.

This is the value that static (Timer_q_double_node) structs need to be initialised to when in debugging mode.

In non-debugging mode this value is all 0's, so this won't do anything different from just declaring your structs as static.

The library will also re-initialise the node back to it's correct form before calling your call back (either for a delete or a run), so you just need to set it up correctly the first time.

This is the value that static (Timer_q_func_node) structs need to be initialised to when in debugging mode.

In non-debugging mode this value is all 0's, so this won't do anything different from just declaring your structs as static.

The library will also re-initialise the node back to it's correct form before calling your call back (either for a delete or a run), so you just need to set it up correctly the first time.

This is the value that static (Timer_q_double_func_node) structs need to be initialised to when in debugging mode.

In non-debugging mode this value is all 0's, so this won't do anything different from just declaring your structs as static.

The library will also re-initialise the node back to it's correct form before calling your call back (either for a delete or a run), so you just need to set it up correctly the first time.

Constants passed to the timer_q call backs

This is the value passed to a (Timer_q_node) call back when it is called from timer_q_run_norm().

This is the value passed to a (Timer_q_node) call back when it is called from timer_q_del_node(), timer_q_del_data() or timer_q_quick_del_node().

This is the value passed to a (Timer_q_node) call back when it is called from timer_q_run_all().

Constants you pass to the timer_q_add_base() function

If this flag is set on a base then when you call timer_q_run_all() all the (Timer_q_node)s call backs for that base will be called.

If this flag is set on a base then when you call timer_q_add_node() the (Timer_q_node) will try to be added from the end of the list.

Regardless of this flag an insert will never traverse the list if it should be added to the beginning or the end of the list.

Also this flag does nothing unless you have (Timer_q_double_node)s as it is not possible to traverse the list backwards.

If this flag is set on a base then when you call timer_q_add_node() without specifying at least one of _SINGLE, _DOUBLE or _FUNC then it will act like you specified _DOUBLE.

If this flag is set on a base then when you call timer_q_add_node() without specifying at least one of _SINGLE, _DOUBLE or _FUNC then it will act like you specified _FUNC.

If this flag is set on a base then when it becaomes empty it will be moved to a non checked list and when a node is added to it again it will be moved back. This means that you will get close to 0 overheard for bases that are rarely used.

This is a default set of flags to pass to timer_q_add_base().

Constants you pass to the timer_q_add_node() function

This flag allows you to override the _MALLOC_DOUBE and _MALLOC_FUNC flags in the base. If you just specify only this flag you will get a normal (Timer_q_node), combining this flag with either of the next 2 is useless.

This flag, or one of the next 2, _must_ be used when calling timer_q_add_static_node() this makes it clear what you have passed in as the first argument of that function.

This flag allows you to override the _MALLOC_DOUBE and _MALLOC_FUNC flags in the base. If you just specify this flag you will get a (Timer_q_node) with a prev pointer as well allowing timer_q_del_node() to operate in O(1) and allowing timer_q_add_node() to use the base option _INSERT_FROM_END. This option can be combined with the next option.

This flag, or one of the previous or next, _must_ be used when calling timer_q_add_static_node() this makes it clear what you have passed in as the first argument of that function.

This flag allows you to override the _MALLOC_DOUBE and _MALLOC_FUNC flags in the base. If you just specify this flag you will get a (Timer_q_node) with a func pointer as well allowing you to specify a different call back for this node compared with the other nodes in the same base. This option can be combined with the previous option.

This flag, or one of the previous 2, _must_ be used when calling timer_q_add_static_node() this makes it clear what you have passed in as the first argument of that function.

This is a default set of flags to pass to timer_q_add_node().

Constants you pass to the timer_q_cntl_node() function

This option will get the current function call back data for the node.

This option will get the current function call back data for the node.

This option will get the current function call back for the node.

This only succeedes if the (timer_q_node) passed is actually a (Timer_q_func_node) or a (Timer_q_double_func_node).

This option will set the current function call back for the node.

This only succeedes if the (timer_q_node) passed is actually a (Timer_q_func_node) or a (Timer_q_double_func_node).

This option will get the current timestamp for the node.

The value returned cannot be altered manually, you will have to copy it first.

This option will set the current timestamp for the node.

This cntl option is not currently implemented.

Constants you pass to the timer_q_cntl_base() function

This option will get the default function call back for the base.

This option will set the default function call back for the base.

This option will get the value of the flag _RUN_ALL on the base.

This option will set the value of the flag _RUN_ALL on the base.

This option will get the value of the flag _INSERT_FROM_END on the base.

This option will set the value of the flag _INSERT_FROM_END on the base.

This option will get the value of the flag _MALLOC_DOUBLE on the base.

This option will set the value of the flag _MALLOC_DOUBLE on the base.

This option will get the value of the flag _MALLOC_FUNC on the base.

This option will set the value of the flag _MALLOC_FUNC on the base.

This option will get the value of the flag _MOVE_WHEN_EMPTY on the base.

This option will set the value of the flag _MOVE_WHEN_EMPTY on the base.

This option will be TRUE when the base has been deleted, this is obviously only possible with a base that has been added via. _add_static_base().

This makes it possible to use _quick_del_base() on static bases.