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

◆ RKH_TR_QUE_INIT

#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_); \
            RKH_TRC_END()

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 165 of file rkhtrc_record.h.

◆ RKH_TR_QUE_GET

#define RKH_TR_QUE_GET	(	queue_,
		nElem_
	)

Value:

            RKH_TRC_BEGIN_WOAOSIG_NOCRIT(RKH_TE_QUE_GET) \
                RKH_TRC_SYM(queue_); \
                RKH_TRC_NE(nElem_); \
            RKH_TRC_END_NOCRIT()

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 183 of file rkhtrc_record.h.

◆ RKH_TR_QUE_FIFO

#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_); \
            RKH_TRC_END()

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 202 of file rkhtrc_record.h.

◆ RKH_TR_QUE_LIFO

#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_); \
            RKH_TRC_END()

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 222 of file rkhtrc_record.h.

◆ RKH_TR_QUE_FULL

#define RKH_TR_QUE_FULL ( queue_ )

Value:

            RKH_TRC_BEGIN_WOAOSIG_NOCRIT(RKH_TE_QUE_FULL) \
                RKH_TRC_SYM(queue_); \
            RKH_TRC_END_NOCRIT()

Queue is full.

Description Queue is full

Group RKH_TG_QUE

EventID RKH_TE_QUE_FULL

Parameters

[in] queue_ Event queue

Definition at line 239 of file rkhtrc_record.h.

◆ RKH_TR_QUE_DPT

#define RKH_TR_QUE_DPT ( queue_ )

Value:

            RKH_TRC_BEGIN_WOAOSIG_NOCRIT(RKH_TE_QUE_DPT) \
                RKH_TRC_SYM(queue_); \
            RKH_TRC_END_NOCRIT()

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 254 of file rkhtrc_record.h.

◆ RKH_TR_QUE_GET_LAST

#define RKH_TR_QUE_GET_LAST ( queue_ )

Value:

            RKH_TRC_BEGIN_WOAOSIG_NOCRIT(RKH_TE_QUE_GET_LAST)  \
                RKH_TRC_SYM(queue_); \
            RKH_TRC_END_NOCRIT()

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 269 of file rkhtrc_record.h.