RKH
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Traces of active objects

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

Macros

#define RKH_TR_SMA_ACT(actObj_, actObjPrio_)
 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_)
 Get an event from the active object's queue. More...
 
#define RKH_TR_SMA_FIFO(actObj_, evt_, sender_, poolID_, refCntr_)
 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_)
 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_, prio)
 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_, prio)
 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...
 

Detailed Description

Macros for tracing the active object execution.

Macro Definition Documentation

#define RKH_TR_SMA_ACT (   actObj_,
  actObjPrio_ 
)
Value:
RKH_TRC_BEGIN_WOSIG(RKH_TE_SMA_ACT, \
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
RKH_TRC_UI8(actObjPrio_); \
Initializes and activates a previously created state machine application (SMA) as known as active obj...
Definition: rkhtrc.h:3335
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhitl.h:224
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
Definition: rkhtrc.h:764
#define RKH_TRC_END()
Definition: rkhtrc.h:606

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

Definition at line 1413 of file rkhtrc.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_); \
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhitl.h:224
Terminate a state machine application (SMA) as known as active object.
Definition: rkhtrc.h:3336
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
Definition: rkhtrc.h:764
#define RKH_TRC_END()
Definition: rkhtrc.h:606

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 1431 of file rkhtrc.h.

#define RKH_TR_SMA_GET (   actObj_,
  evt_,
  poolID_,
  refCntr_ 
)
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_); \
#define RKH_TRC_SIG(e)
Definition: rkhtrc.h:1142
Get an event from the active object's queue.
Definition: rkhtrc.h:3337
#define RKH_TRC_SYM(sym)
Insert a object address as trace record argument.
Definition: rkhtrc.h:992
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhitl.h:224
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
Definition: rkhtrc.h:764
#define RKH_TRC_END()
Definition: rkhtrc.h:606
#define RKH_TRC_BEGIN(eid_, prio_, sig_)
Definition: rkhtrc.h:568

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)

Definition at line 1451 of file rkhtrc.h.

#define RKH_TR_SMA_FIFO (   actObj_,
  evt_,
  sender_,
  poolID_,
  refCntr_ 
)
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_); \
#define RKH_TRC_SNDR(sym)
Insert a sender object address as trace record argument.
Definition: rkhtrc.h:1001
#define RKH_TRC_SIG(e)
Definition: rkhtrc.h:1142
#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
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhitl.h:224
#define RKH_TRC_BEGIN_NOCRIT(eid_, prio_, sig_)
Definition: rkhtrc.h:618
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
Definition: rkhtrc.h:764
Send an event to a state machine application (SMA) as known as active object through a queue using th...
Definition: rkhtrc.h:3338

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)

Definition at line 1474 of file rkhtrc.h.

#define RKH_TR_SMA_LIFO (   actObj_,
  evt_,
  sender_,
  poolID_,
  refCntr_ 
)
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_); \
#define RKH_TRC_SNDR(sym)
Insert a sender object address as trace record argument.
Definition: rkhtrc.h:1001
#define RKH_TRC_SIG(e)
Definition: rkhtrc.h:1142
#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
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhitl.h:224
#define RKH_TRC_BEGIN_NOCRIT(eid_, prio_, sig_)
Definition: rkhtrc.h:618
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
Definition: rkhtrc.h:764
Send an event to a state machine application (SMA) as known as active object through a queue using th...
Definition: rkhtrc.h:3339

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_ACT
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)

Definition at line 1498 of file rkhtrc.h.

#define RKH_TR_SMA_REG (   actObj_,
  prio 
)
Value:
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
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.
Definition: rkhtrc.h:3340
#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
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhitl.h:224
#define RKH_TRC_BEGIN_WOSIG_NOCRIT(eid_, prio_)
Definition: rkhtrc.h:645
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
Definition: rkhtrc.h:764

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]prioActive object priority

Definition at line 1519 of file rkhtrc.h.

#define RKH_TR_SMA_UNREG (   actObj_,
  prio 
)
Value:
RKH_SMA_ACCESS_CONST(actObj_, prio)) \
RKH_TRC_SYM(actObj_); \
Removes the SMA as known as active object from the priority table, and thus from the framework...
Definition: rkhtrc.h:3341
#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
#define RKH_SMA_ACCESS_CONST(me_, member_)
Macro for accessing to members of state machine structure.
Definition: rkhitl.h:224
#define RKH_TRC_BEGIN_WOSIG_NOCRIT(eid_, prio_)
Definition: rkhtrc.h:645
#define RKH_TRC_UI8(d)
Insert a 1-byte data.
Definition: rkhtrc.h:764

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]prioActive object priority

Definition at line 1537 of file rkhtrc.h.