RKH
Traces of active objects

Macros for tracing the active object execution. More...

Macros

#define RKH_TR_SMA_ACT(actObj_, actObjPrio_, actObjQueSize_)
 Initializes and activates a previously created state machine application (SMA) as known as active object. More...
 
#define RKH_TR_SMA_TERM(actObj_, actObjPrio_)
 Terminate a state machine application (SMA) as known as active object. More...
 
#define RKH_TR_SMA_GET(actObj_, evt_, poolID_, refCntr_, nElem_, nMin_)
 Get an event from the active object's queue. More...
 
#define RKH_TR_SMA_FIFO(actObj_, evt_, sender_, poolID_, refCntr_, nElem_, nMin_)
 Send an event to a state machine application (SMA) as known as active object through a queue using the FIFO policy. A message is a pointer size variable and its use is application specific. More...
 
#define RKH_TR_SMA_LIFO(actObj_, evt_, sender_, poolID_, refCntr_, nElem_, nMin_)
 Send an event to a state machine application (SMA) as known as active object through a queue using the LIFO policy. A message is a pointer size variable and its use is application specific. More...
 
#define RKH_TR_SMA_REG(actObj_, actObjPrio_)
 Registers a state machine application (SMA) as known as active object into the framework, which implies to store a pointer to the SMA in the priority table. More...
 
#define RKH_TR_SMA_UNREG(actObj_, actObjPrio_)
 Removes the SMA as known as active object from the priority table, and thus from the framework, by simply replacing the link to the SMA being deleted with a NULL pointer. More...
 
#define RKH_TR_SMA_DEFER(queue_, evt_)
 Defer an event to a given separate event queue. More...
 
#define RKH_TR_SMA_RCALL(actObj_, evt_)
 Recall a deferred event from a given event queue. More...
 

Detailed Description

Macros for tracing the active object execution.

Macro Definition Documentation

#define RKH_TR_SMA_ACT (   actObj_,
  actObjPrio_,
  actObjQueSize_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SMA_ACT, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_UI8(actObjPrio_); \
RKH_TRC_UI8(actObjQueSize_); \
RKH_TRC_END()
#define RKH_TE_SMA_ACT
Initializes and activates a previously created state machine application (SMA) as known as active obj...
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Initializes and activates a previously created state machine application (SMA) as known as active object.

Description
Activate an active object
Group
RKH_TG_SMA
EventID
RKH_TE_SMA_ACT
Parameters
[in]actObj_Active object
[in]actObjPrio_Active object priority
[in]actObjQueSize_Size of active object queue

Definition at line 306 of file rkhtrc_record.h.

#define RKH_TR_SMA_TERM (   actObj_,
  actObjPrio_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SMA_TERM, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_UI8(actObjPrio_); \
RKH_TRC_END()
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96
#define RKH_TE_SMA_TERM
Terminate a state machine application (SMA) as known as active object.

Terminate a state machine application (SMA) as known as active object.

Description
Terminate an active object
Group
RKH_TG_SMA
EventID
RKH_TE_SMA_TERM
Parameters
[in]actObj_Active object
[in]actObjPrio_Active object priority

Definition at line 325 of file rkhtrc_record.h.

#define RKH_TR_SMA_GET (   actObj_,
  evt_,
  poolID_,
  refCntr_,
  nElem_,
  nMin_ 
)
Value:
RKH_SMA_ACCESS_CONST(actObj_, prio), (evt_)->e) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SIG((evt_)->e); \
RKH_TRC_UI8(poolID_); \
RKH_TRC_UI8(refCntr_); \
RKH_TRC_NE(nElem_); \
RKH_TRC_QUE_NMIN(nMin_); \
RKH_TRC_END()
#define RKH_TRC_BEGIN(eid_, prio_, sig_)
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96
#define RKH_TE_SMA_GET
Get an event from the active object's queue.

Get an event from the active object's queue.

Description
Group
RKH_TG_SMA
EventID
RKH_TE_SMA_GET
Parameters
[in]actObj_Get an event from the active object queue
[in]evt_Event signal
[in]poolID_Pool ID (for dynamic events)
[in]refCntr_Reference count (for dynamic events)
[in]nElem_Number of elements currently in the queue
[in]nMin_Minimum number of free elements ever in this queue

Definition at line 350 of file rkhtrc_record.h.

#define RKH_TR_SMA_FIFO (   actObj_,
  evt_,
  sender_,
  poolID_,
  refCntr_,
  nElem_,
  nMin_ 
)
Value:
RKH_SMA_ACCESS_CONST(actObj_, prio), \
(evt_)->e) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SIG((evt_)->e); \
RKH_TRC_SNDR(sender_); \
RKH_TRC_UI8(poolID_); \
RKH_TRC_UI8(refCntr_); \
RKH_TRC_NE(nElem_); \
RKH_TRC_QUE_NMIN(nMin_); \
RKH_TRC_END_NOCRIT()
#define RKH_TRC_BEGIN_NOCRIT(eid_, prio_, sig_)
#define RKH_TE_SMA_FIFO
Send an event to a state machine application (SMA) as known as active object through a queue using th...
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Send an event to a state machine application (SMA) as known as active object through a queue using the FIFO policy. A message is a pointer size variable and its use is application specific.

Description
Send a event to SMA's queue in a FIFO manner
Group
RKH_TG_SMA
EventID
RKH_TE_SMA_FIFO
Parameters
[in]actObj_Active object
[in]evt_Event signal
[in]sender_Event sender
[in]poolID_Pool ID (for dynamic events)
[in]refCntr_Reference count (for dynamic events)
[in]nElem_Number of elements currently in the queue
[in]nMin_Minimum number of free elements ever in this queue

Definition at line 380 of file rkhtrc_record.h.

#define RKH_TR_SMA_LIFO (   actObj_,
  evt_,
  sender_,
  poolID_,
  refCntr_,
  nElem_,
  nMin_ 
)
Value:
RKH_SMA_ACCESS_CONST(actObj_, prio), \
(evt_)->e) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_SIG((evt_)->e); \
RKH_TRC_SNDR(sender_); \
RKH_TRC_UI8(poolID_); \
RKH_TRC_UI8(refCntr_); \
RKH_TRC_NE(nElem_); \
RKH_TRC_QUE_NMIN(nMin_); \
RKH_TRC_END_NOCRIT()
#define RKH_TRC_BEGIN_NOCRIT(eid_, prio_, sig_)
#define RKH_TE_SMA_LIFO
Send an event to a state machine application (SMA) as known as active object through a queue using th...
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Send an event to a state machine application (SMA) as known as active object through a queue using the LIFO policy. A message is a pointer size variable and its use is application specific.

Description
Send a event to SMA's queue in a LIFO manner
Group
RKH_TG_SMA
EventID
RKH_TE_SMA_LIFO
Parameters
[in]actObj_Active object
[in]evt_Event signal
[in]sender_Event sender
[in]poolID_Pool ID (for dynamic events)
[in]refCntr_Reference count (for dynamic events)
[in]nElem_Number of elements currently in the queue
[in]nMin_Minimum number of free elements ever in this queue

Definition at line 412 of file rkhtrc_record.h.

#define RKH_TR_SMA_REG (   actObj_,
  actObjPrio_ 
)
Value:
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_UI8(actObjPrio_); \
RKH_TRC_END_NOCRIT()
#define RKH_TRC_BEGIN_WOSIG_NOCRIT(eid_, prio_)
#define RKH_TE_SMA_REG
Registers a state machine application (SMA) as known as active object into the framework, which implies to store a pointer to the SMA in the priority table.
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Registers a state machine application (SMA) as known as active object into the framework, which implies to store a pointer to the SMA in the priority table.

Description
Register an active object
Group
RKH_TG_SMA
EventID
RKH_TE_SMA_REG
Parameters
[in]actObj_Active object
[in]actObjPrio_Active object priority

Definition at line 437 of file rkhtrc_record.h.

#define RKH_TR_SMA_UNREG (   actObj_,
  actObjPrio_ 
)
Value:
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_UI8(actObjPrio_); \
RKH_TRC_END_NOCRIT()
#define RKH_TRC_BEGIN_WOSIG_NOCRIT(eid_, prio_)
#define RKH_TE_SMA_UNREG
Removes the SMA as known as active object from the priority table, and thus from the framework...
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhsma.h:96

Removes the SMA as known as active object from the priority table, and thus from the framework, by simply replacing the link to the SMA being deleted with a NULL pointer.

Description
Unregister an active object
Group
RKH_TG_SMA
EventID
RKH_TE_SMA_UNREG
Parameters
[in]actObj_Active object
[in]actObjPrio_Active object priority

Definition at line 455 of file rkhtrc_record.h.

#define RKH_TR_SMA_DEFER (   queue_,
  evt_ 
)
Value:
RKH_TRC_SYM(queue_); \
RKH_TRC_SIG((evt_)->e); \
RKH_TRC_END_NOCRIT()
#define RKH_TE_SMA_DEFER
Defer an event to a given separate event queue.
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)

Defer an event to a given separate event queue.

Description
Defer an event
Group
RKH_TG_SMA
EventID
RKH_TE_SMA_DEFER
Parameters
[in]queue_Target queue to store deferred event
[in]evt_Event

Definition at line 473 of file rkhtrc_record.h.

#define RKH_TR_SMA_RCALL (   actObj_,
  evt_ 
)
Value:
RKH_TRC_SYM(actObj_); \
RKH_TRC_SIG((evt_)->e); \
RKH_TRC_END_NOCRIT()
#define RKH_TE_SMA_RCALL
Recall a deferred event from a given event queue.
#define RKH_TRC_BEGIN_WOAOSIG_NOCRIT(eid_)

Recall a deferred event from a given event queue.

Description
Recall an event
Group
RKH_TG_SMA
EventID
RKH_TE_SMA_RCALL
Parameters
[in]actObj_Active object
[in]evt_Event

Definition at line 490 of file rkhtrc_record.h.