VSF Documented
Macros | Typedefs
vsf_timq_dlist.h File Reference
#include "kernel/vsf_kernel_cfg.h"

Go to the source code of this file.

Macros

#define vsf_timq_init(__queue)
 Initialize a timer queue.
 
#define vsf_timq_insert(__queue, __teda)
 Insert a timer eda into the timer queue, sorted in ascending order of due.
 
#define vsf_timq_remove(__queue, __teda)
 Remove a timer eda from the timer queue.
 
#define vsf_timq_peek(__queue, __teda)
 Get the head timer eda (the earliest due) of the timer queue without removing it.
 
#define vsf_timq_dequeue(__queue, __teda)
 Remove the head timer eda (the earliest due) from the timer queue.
 
#define vsf_callback_timq_init(__queue)
 Initialize a callback timer queue.
 
#define vsf_callback_timq_enqueue(__queue, __timer)
 Enqueue a callback timer to the tail of the timer queue (FIFO order)
 
#define vsf_callback_timq_insert(__queue, __timer)
 Insert a callback timer into the timer queue, sorted in ascending order of due.
 
#define vsf_callback_timq_remove(__queue, __timer)
 Remove a callback timer from the timer queue.
 
#define vsf_callback_timq_peek(__queue, __timer)
 Get the head callback timer of the timer queue without removing it.
 
#define vsf_callback_timq_dequeue(__queue, __timer)
 Remove the head callback timer from the timer queue.
 

Typedefs

typedef vsf_dlist_t vsf_timer_queue_t
 

Macro Definition Documentation

◆ vsf_timq_init

#define vsf_timq_init ( __queue)
Value:
vsf_dlist_init(__queue)
vsf_dlist_init
#define vsf_dlist_init(__list_ptr)
Definition vsf_list.h:702

Initialize a timer queue.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_timq_insert

#define vsf_timq_insert ( __queue,
__teda )
Value:
vsf_dlist_insert( \
vsf_teda_t, timer_node, \
(__queue), \
(__teda), \
_->due >= (__teda)->due)
vsf_teda_t
eda with timer support (can use vsf_teda_set_timer() etc.); derived classes (task/pt/thread) inherit ...
Definition vsf_eda.h:1916
vsf_dlist_insert
#define vsf_dlist_insert( __host_type, __member, __list_ptr, __item_ptr, __cond)
Definition vsf_list.h:769
_
struct @905::@910 _

Insert a timer eda into the timer queue, sorted in ascending order of due.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
[in]__tedaa pointer to the vsf_teda_t to insert
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_timq_remove

#define vsf_timq_remove ( __queue,
__teda )
Value:
vsf_dlist_remove( \
vsf_teda_t, timer_node, \
(__queue), \
(__teda))
vsf_dlist_remove
#define vsf_dlist_remove( __host_type, __member, __list_ptr, __item_ptr)
Definition vsf_list.h:810

Remove a timer eda from the timer queue.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
[in]__tedaa pointer to the vsf_teda_t to remove
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_timq_peek

#define vsf_timq_peek ( __queue,
__teda )
Value:
vsf_dlist_queue_peek( \
vsf_teda_t, timer_node, \
(__queue), \
(__teda))
vsf_dlist_queue_peek
#define vsf_dlist_queue_peek( __host_type, __member, __list_ptr, __item_ref_ptr)
Definition vsf_list.h:845

Get the head timer eda (the earliest due) of the timer queue without removing it.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
[out]__tedaa vsf_teda_t pointer variable receiving the head timer eda, NULL if the queue is empty
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_timq_dequeue

#define vsf_timq_dequeue ( __queue,
__teda )
Value:
vsf_dlist_queue_dequeue( \
vsf_teda_t, timer_node, \
(__queue), \
(__teda))
vsf_dlist_queue_dequeue
#define vsf_dlist_queue_dequeue(__host_type, __member, __list_ptr, __item_ref_ptr)
Definition vsf_list.h:859

Remove the head timer eda (the earliest due) from the timer queue.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
[out]__tedaa vsf_teda_t pointer variable receiving the removed head timer eda, NULL if the queue is empty
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_callback_timq_init

#define vsf_callback_timq_init ( __queue)
Value:
vsf_dlist_init(__queue)

Initialize a callback timer queue.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_callback_timq_enqueue

#define vsf_callback_timq_enqueue ( __queue,
__timer )
Value:
vsf_dlist_queue_enqueue( \
vsf_callback_timer_t, timer_node, \
(__queue), \
(__timer))
vsf_callback_timer_t
Task-independent timer; when it expires the kernel task invokes the user callback.
Definition vsf_eda.h:1937
vsf_dlist_queue_enqueue
#define vsf_dlist_queue_enqueue(__host_type, __member, __list_ptr, __item_ptr)
Definition vsf_list.h:852

Enqueue a callback timer to the tail of the timer queue (FIFO order)

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
[in]__timera pointer to the vsf_callback_timer_t to enqueue
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_callback_timq_insert

#define vsf_callback_timq_insert ( __queue,
__timer )
Value:
vsf_dlist_insert( \
vsf_callback_timer_t, timer_node, \
(__queue), \
(__timer), \
_->due >= (__timer)->due)

Insert a callback timer into the timer queue, sorted in ascending order of due.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
[in]__timera pointer to the vsf_callback_timer_t to insert
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_callback_timq_remove

#define vsf_callback_timq_remove ( __queue,
__timer )
Value:
vsf_dlist_remove( \
vsf_callback_timer_t, timer_node, \
(__queue), \
(__timer))

Remove a callback timer from the timer queue.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
[in]__timera pointer to the vsf_callback_timer_t to remove
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_callback_timq_peek

#define vsf_callback_timq_peek ( __queue,
__timer )
Value:
vsf_dlist_queue_peek( \
vsf_callback_timer_t, timer_node, \
(__queue), \
(__timer))

Get the head callback timer of the timer queue without removing it.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
[out]__timera vsf_callback_timer_t pointer variable receiving the head callback timer, NULL if the queue is empty
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

◆ vsf_callback_timq_dequeue

#define vsf_callback_timq_dequeue ( __queue,
__timer )
Value:
vsf_dlist_queue_dequeue( \
vsf_callback_timer_t, timer_node, \
(__queue), \
(__timer))

Remove the head callback timer from the timer queue.

Parameters
[in]__queuea pointer to the timer queue of type vsf_timer_queue_t
[out]__timera vsf_callback_timer_t pointer variable receiving the removed head callback timer, NULL if the queue is empty
Note
Used internally by the kernel timer implementation; users normally do not call it directly.

Typedef Documentation

◆ vsf_timer_queue_t

typedef vsf_dlist_t vsf_timer_queue_t
Generated from commit: vsfteam/vsf@a5104db