RKH
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Traces of event queue services

Macros for tracing the event queue execution. More...

Macros

#define RKH_TR_QUE_INIT(queue_, actObj_, nElem_)
 Initializes the previously allocated queue data structure RKH_QUEUE_T. More...
 
#define RKH_TR_QUE_GET(queue_, nElem_)
 Get and remove an element from a queue. More...
 
#define RKH_TR_QUE_FIFO(queue_, nElem_, nMin_)
 Puts an element on a queue in a FIFO manner. The element is queued by reference, not by copy. More...
 
#define RKH_TR_QUE_LIFO(queue_, nElem_, nMin_)
 Puts an element on a queue in a LIFO manner. The element is queued by reference, not by copy. More...
 
#define RKH_TR_QUE_FULL(queue_)
 Queue is full. More...
 
#define RKH_TR_QUE_DPT(queue_)
 Depletes a queue. Empties the contents of the queue and eliminates all stored elements. More...
 
#define RKH_TR_QUE_GET_LAST(queue_)
 Get the last element from the queue. More...
 

Detailed Description

Macros for tracing the event queue execution.

Macro Definition Documentation

#define RKH_TR_QUE_INIT (   queue_,
  actObj_,
  nElem_ 
)
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_QUE_INIT) \
RKH_TRC_SYM(queue_); \
RKH_TRC_SYM(actObj_); \
RKH_TRC_NE(nElem_); \
#define RKH_TE_QUE_INIT
Initializes the previously allocated queue data structure RKH_QUEUE_T.
#define RKH_TRC_NE(ne)
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.

Initializes the previously allocated queue data structure RKH_QUEUE_T.

Description
Initialize a event queue
Group
RKH_TG_QUE
EventID
RKH_TE_QUE_INIT
Parameters
[in]queue_Event queue
[in]actObj_Associated active object that receives the equeued events.
[in]nElem_Storage size [in the units of void pointers]

Definition at line 163 of file rkhtrc_record.h.

#define RKH_TR_QUE_GET (   queue_,
  nElem_ 
)
Value:
RKH_TRC_SYM(queue_); \
RKH_TRC_NE(nElem_); \
#define RKH_TRC_END_NOCRIT()
#define RKH_TRC_NE(ne)
#define RKH_TE_QUE_GET
Get and remove an element from a queue.
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)

Get and remove an element from a queue.

Description
Get and remove an element from a queue
Group
RKH_TG_QUE
EventID
RKH_TE_QUE_GET
Parameters
[in]queue_Event queue
[in]nElem_Number of elements currently in the queue

Definition at line 181 of file rkhtrc_record.h.

#define RKH_TR_QUE_FIFO (   queue_,
  nElem_,
  nMin_ 
)
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_QUE_FIFO) \
RKH_TRC_SYM(queue_); \
RKH_TRC_NE(nElem_); \
RKH_TRC_QUE_NMIN(nMin_); \
#define RKH_TE_QUE_FIFO
Puts an element on a queue in a FIFO manner. The element is queued by reference, not by copy...
#define RKH_TRC_NE(ne)
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.

Puts an element on a queue in a FIFO manner. The element is queued by reference, not by copy.

Description
Puts an element on a queue in a FIFO manner
Group
RKH_TG_QUE
EventID
RKH_TE_QUE_FIFO
Parameters
[in]queue_Event queue
[in]nElem_Number of elements currently in the queue
[in]nMin_Minimum number of free elements ever in this queue

Definition at line 200 of file rkhtrc_record.h.

#define RKH_TR_QUE_LIFO (   queue_,
  nElem_,
  nMin_ 
)
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_QUE_LIFO) \
RKH_TRC_SYM(queue_); \
RKH_TRC_NE(nElem_); \
RKH_TRC_QUE_NMIN(nMin_); \
#define RKH_TRC_NE(ne)
#define RKH_TE_QUE_LIFO
Puts an element on a queue in a LIFO manner. The element is queued by reference, not by copy...
#define RKH_TRC_END()
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.

Puts an element on a queue in a LIFO manner. The element is queued by reference, not by copy.

Description
Puts an element on a queue in a LIFO manner
Group
RKH_TG_QUE
EventID
RKH_TE_QUE_LIFO
Parameters
[in]queue_Event queue
[in]nElem_Number of elements currently in the queue
[in]nMin_Minimum number of free elements ever in this queue

Definition at line 220 of file rkhtrc_record.h.

#define RKH_TR_QUE_FULL (   queue_)
Value:
RKH_TRC_SYM(queue_); \
#define RKH_TRC_END_NOCRIT()
#define RKH_TE_QUE_FULL
Queue is full.
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)

Queue is full.

Description
Queue is full
Group
RKH_TG_QUE
EventID
RKH_TE_QUE_FULL
Parameters
[in]queue_Event queue

Definition at line 237 of file rkhtrc_record.h.

#define RKH_TR_QUE_DPT (   queue_)
Value:
RKH_TRC_SYM(queue_); \
#define RKH_TRC_END_NOCRIT()
#define RKH_TE_QUE_DPT
Depletes a queue. Empties the contents of the queue and eliminates all stored elements.
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)

Depletes a queue. Empties the contents of the queue and eliminates all stored elements.

Description
Depletes a queue
Group
RKH_TG_QUE
EventID
RKH_TE_QUE_DPT
Parameters
[in]queue_Event queue

Definition at line 252 of file rkhtrc_record.h.

#define RKH_TR_QUE_GET_LAST (   queue_)
Value:
RKH_TRC_SYM(queue_); \
#define RKH_TRC_END_NOCRIT()
#define RKH_TE_QUE_GET_LAST
Get the last element from the queue.
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)

Get the last element from the queue.

Description
Get the last element from the queue
Group
RKH_TG_QUE
EventID
RKH_TE_QUE_GET_LAST
Parameters
[in]queue_Event queue

Definition at line 267 of file rkhtrc_record.h.