FW Profile - C1 Implementation
FwRtDesc Struct Reference

Structure representing a RT Container Descriptor. More...

Data Fields

FwRtState_t state
 The state of the RT Container. More...
 
pthread_attr_t * pThreadAttr
 The pointer to the Activation Thread attributes. More...
 
pthread_mutexattr_t * pMutexAttr
 The pointer to the mutex attributes. More...
 
pthread_condattr_t * pCondAttr
 The pointer to the condition variable attributes. More...
 
pthread_t activationThread
 The thread associated to the RT Container. More...
 
pthread_mutex_t mutex
 The mutex associated to the RT Container. More...
 
pthread_cond_t cond
 The condition variable associated to the RT Container.
 
FwRtCounterU2_t notifCounter
 The notification counter.
 
FwRtAction_t initializeNotifPr
 Pointer to the function encapsulating the initialization action for the Notification Procedure. More...
 
FwRtAction_t finalizeNotifPr
 Pointer to the function encapsulating the finalization action for the Notification Procedure. More...
 
FwRtAction_t implementNotifLogic
 Pointer to the function encapsulating the implementation of the notification logic. More...
 
FwRtAction_t initializeActivPr
 Pointer to the function encapsulating the initialization action for the Activation Procedure. More...
 
FwRtAction_t finalizeActivPr
 Pointer to the function encapsulating the finalization action for the Activation Procedure. More...
 
FwRtAction_t setUpNotification
 Pointer to the function encapsulating the logic to set up the notification for the RT Container. More...
 
FwRtAction_t implementActivLogic
 Pointer to the function encapsulating the implementation of the activation logic. More...
 
FwRtAction_t execFuncBehaviour
 Pointer to the function encapsulating the execution of the functional behaviour associated to the RT Container. More...
 
FwRtBool_t notifPrStarted
 The flag indicating whether the Notification Procedure is STÂRTED. More...
 
FwRtBool_t activPrStarted
 The flag indicating whether the Activation Procedure is STÂRTED. More...
 
int errCode
 The return value of the last system call which failed. More...
 
void * rtData
 The pointer to the RT Container data. More...
 

Detailed Description

Structure representing a RT Container Descriptor.

The RT Container Descriptor holds all the information which describes a RT Container. This consists of:

  • The STARTED/STOPPED state of the RT Container;
  • The activation thread;
  • The lock (a mutex) associated to the RT Container;
  • The state of the Notification and Activation Procedures associated to the container;
  • The pointers to the functions which implement the adaptation points of the container;
  • The outcome of the last action executed by the Notification Procedure;
  • The outcome of the last action executed by the Activation Procedure;
  • The error code for the RT Container;
  • A pointer to a user-defined data structure to hold the container's data.

The STARTED/STOPPED state of the RT Container is not stored explicitly because a RT Container is started if and only if its pthread object is non-NULL.

Definition at line 128 of file FwRtConstants.h.

Field Documentation

pthread_t activationThread

The thread associated to the RT Container.

Definition at line 150 of file FwRtConstants.h.

FwRtBool_t activPrStarted

The flag indicating whether the Activation Procedure is STÂRTED.

Definition at line 251 of file FwRtConstants.h.

int errCode

The return value of the last system call which failed.

Definition at line 253 of file FwRtConstants.h.

FwRtAction_t execFuncBehaviour

Pointer to the function encapsulating the execution of the functional behaviour associated to the RT Container.

This is a user-defined function. After the Activation Procedure has been executed for the first time, this function is called every time the procedure is executed as long as the RT Container has not been stopped. This procedure should implement the functional behaviour associated to the RT Container. The function returns 1 if the execution of the functional behaviour has terminated and it returns 0 if the execution of the functional behaviour is not yet terminated.

Definition at line 247 of file FwRtConstants.h.

FwRtAction_t finalizeActivPr

Pointer to the function encapsulating the finalization action for the Activation Procedure.

This is a user-defined function. This function is called just before the Activation Procedure terminates. It should perform any finalization action which is required by the Activation Procedure. The function always returns a value of 1.

Definition at line 211 of file FwRtConstants.h.

FwRtAction_t finalizeNotifPr

Pointer to the function encapsulating the finalization action for the Notification Procedure.

This is a user-defined function. This function is called just before the Notification Procedure terminates. It should perform any finalization action which is required by the Notification Procedure. The function always returns a value of 1.

Definition at line 177 of file FwRtConstants.h.

FwRtAction_t implementActivLogic

Pointer to the function encapsulating the implementation of the activation logic.

This is a user-defined function. After the Activation Procedure has been executed for the first time, this function is called every time the procedure is executed as long as the RT Container has not been stopped. This procedure should implement the logic which decides whether the Functional Behaviour associated to the RT Container is executed. The function returns 1 if the container's functional behaviour should be executed and it returns 0 if the container's functional behaviour should not be executed.

Definition at line 234 of file FwRtConstants.h.

FwRtAction_t implementNotifLogic

Pointer to the function encapsulating the implementation of the notification logic.

This is a user-defined function. After the Notification Procedure has been executed for the first time, this function is called every time the procedure is executed as long as the Notification Procedure has not been stopped. This procedure should implement the logic which decides whether the Activation Thread should be notified. The function returns 1 if the Activation Thread is to be notified or it returns 0 if the notification of the Activation Thread should be skipped.

Definition at line 190 of file FwRtConstants.h.

FwRtAction_t initializeActivPr

Pointer to the function encapsulating the initialization action for the Activation Procedure.

This is a user-defined function. This function is called once when the Activation Procedure is executed for the first time. It should perform any initialization action which is required by the Activation Procedure. The function always returns a value of 1.

Definition at line 201 of file FwRtConstants.h.

FwRtAction_t initializeNotifPr

Pointer to the function encapsulating the initialization action for the Notification Procedure.

This is a user-defined function. This function is called once when the Notification Procedure is executed for the first time. It should perform any initialization action which is required by the Notification Procedure. The function always returns a value of 1.

Definition at line 167 of file FwRtConstants.h.

pthread_mutex_t mutex

The mutex associated to the RT Container.

Definition at line 152 of file FwRtConstants.h.

FwRtBool_t notifPrStarted

The flag indicating whether the Notification Procedure is STÂRTED.

Definition at line 249 of file FwRtConstants.h.

pthread_condattr_t* pCondAttr

The pointer to the condition variable attributes.

The default value of NULL indicates the default values of a pthread condition variable attributes should be used.

Definition at line 148 of file FwRtConstants.h.

pthread_mutexattr_t* pMutexAttr

The pointer to the mutex attributes.

The default value of NULL indicates the default values of a pthread mutex attributes should be used.

Definition at line 142 of file FwRtConstants.h.

pthread_attr_t* pThreadAttr

The pointer to the Activation Thread attributes.

The default value of NULL indicates the default values of a pthread attributes should be used.

Definition at line 136 of file FwRtConstants.h.

void* rtData

The pointer to the RT Container data.

Definition at line 255 of file FwRtConstants.h.

FwRtAction_t setUpNotification

Pointer to the function encapsulating the logic to set up the notification for the RT Container.

This is a user-defined function. This function is called each time the Activation Procedure is executed. This function may be used to implement the logic which determines when the next notification is sent to the RT Container. The function always returns a value of 1.

Definition at line 221 of file FwRtConstants.h.

FwRtState_t state

The state of the RT Container.

Definition at line 130 of file FwRtConstants.h.


The documentation for this struct was generated from the following file:
P&P Software GmbH, Copyright 2011, All Rights Reserved