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_RQ_INIT(queue_, actObj_, nElem_)
 Initializes the previously allocated queue data structure RKH_RQ_T. More...
 
#define RKH_TR_RQ_GET(queue_, nElem_)
 Get and remove an element from a queue. More...
 
#define RKH_TR_RQ_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_RQ_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_RQ_FULL(queue_)
 Queue is full. More...
 
#define RKH_TR_RQ_DPT(queue_)
 Depletes a queue. Empties the contents of the queue and eliminates all stored elements. More...
 
#define RKH_TR_RQ_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_RQ_INIT (   queue_,
  actObj_,
  nElem_ 
)
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_RQ_INIT) \
RKH_TRC_SYM(queue_); \
RKH_TRC_SYM(actObj_); \
RKH_TRC_NE(nElem_); \
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_TRC_NE(ne)
Definition: rkhtrc.h:1101
Initializes the previously allocated queue data structure RKH_RQ_T.
Definition: rkhtrc.h:3325
#define RKH_TRC_END()
Definition: rkhtrc.h:606

Initializes the previously allocated queue data structure RKH_RQ_T.

Description
Initialize a event queue
Group
RKH_TG_RQ
EventID
RKH_TE_RQ_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 1271 of file rkhtrc.h.

#define RKH_TR_RQ_GET (   queue_,
  nElem_ 
)
Value:
RKH_TRC_SYM(queue_); \
RKH_TRC_NE(nElem_); \
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_TRC_NE(ne)
Definition: rkhtrc.h:1101
#define RKH_TRC_END_NOCRIT()
Definition: rkhtrc.h:665
Get and remove an element from a queue.
Definition: rkhtrc.h:3326
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)
Definition: rkhtrc.h:657

Get and remove an element from a queue.

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

Definition at line 1289 of file rkhtrc.h.

#define RKH_TR_RQ_FIFO (   queue_,
  nElem_,
  nMin_ 
)
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_RQ_FIFO) \
RKH_TRC_SYM(queue_); \
RKH_TRC_NE(nElem_); \
RKH_TRC_RQ_NMIN(nMin_); \
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_TRC_NE(ne)
Definition: rkhtrc.h:1101
Puts an element on a queue in a FIFO manner. The element is queued by reference, not by copy...
Definition: rkhtrc.h:3327
#define RKH_TRC_END()
Definition: rkhtrc.h:606

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_RQ
EventID
RKH_TE_RQ_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 1308 of file rkhtrc.h.

#define RKH_TR_RQ_LIFO (   queue_,
  nElem_,
  nMin_ 
)
Value:
RKH_TRC_BEGIN_WOAOSIG(RKH_TE_RQ_LIFO) \
RKH_TRC_SYM(queue_); \
RKH_TRC_NE(nElem_); \
RKH_TRC_RQ_NMIN(nMin_); \
Puts an element on a queue in a LIFO manner. The element is queued by reference, not by copy...
Definition: rkhtrc.h:3328
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_TRC_NE(ne)
Definition: rkhtrc.h:1101
#define RKH_TRC_END()
Definition: rkhtrc.h:606

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_RQ
EventID
RKH_TE_RQ_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 1328 of file rkhtrc.h.

#define RKH_TR_RQ_FULL (   queue_)
Value:
RKH_TRC_SYM(queue_); \
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_TRC_END_NOCRIT()
Definition: rkhtrc.h:665
Queue is full.
Definition: rkhtrc.h:3329
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)
Definition: rkhtrc.h:657

Queue is full.

Description
Queue is full
Group
RKH_TG_RQ
EventID
RKH_TE_RQ_FULL
Parameters
[in]queue_Event queue

Definition at line 1345 of file rkhtrc.h.

#define RKH_TR_RQ_DPT (   queue_)
Value:
RKH_TRC_SYM(queue_); \
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_TRC_END_NOCRIT()
Definition: rkhtrc.h:665
Depletes a queue. Empties the contents of the queue and eliminates all stored elements.
Definition: rkhtrc.h:3330
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)
Definition: rkhtrc.h:657

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

Description
Depletes a queue
Group
RKH_TG_RQ
EventID
RKH_TE_RQ_DPT
Parameters
[in]queue_Event queue

Definition at line 1360 of file rkhtrc.h.

#define RKH_TR_RQ_GET_LAST (   queue_)
Value:
RKH_TRC_SYM(queue_); \
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_TRC_END_NOCRIT()
Definition: rkhtrc.h:665
Get the last element from the queue.
Definition: rkhtrc.h:3331
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)
Definition: rkhtrc.h:657

Get the last element from the queue.

Description
Get the last element from the queue
Group
RKH_TG_RQ
EventID
RKH_TE_RQ_GET_LAST
Parameters
[in]queue_Event queue

Definition at line 1375 of file rkhtrc.h.