CORDET Framework - C2 Implementation
cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h File Reference

User-modifiable parameters for the OutStream components (see CrFwOutStream.h) of the Slave 1 Application of the CORDET Demo. More...

Go to the source code of this file.

Macros

#define CR_FW_NOF_OUTSTREAM   2
 The number of OutStream components in the application. More...
 
#define CR_FW_OUTSTREAM_PQSIZE   {10,10}
 The sizes of the packet queues in the OutStream component. More...
 
#define CR_FW_OUTSTREAM_DEST   {CR_DA_MASTER,CR_DA_SLAVE_2}
 The destinations of the OutStream components. More...
 
#define CR_FW_OUTSTREAM_NOF_GROUPS   {1,1}
 The number of groups of the OutStream components. More...
 
#define CR_FW_OUTSTREAM_PCKTHANDOVER   {&CrDaServerSocketPcktHandover,&CrDaServerSocketPcktHandover}
 The functions implementing the packet hand-over operations of the OutStream components. More...
 
#define CR_FW_OUTSTREAM_INITCHECK   {&CrDaServerSocketInitCheck,&CrDaServerSocketInitCheck}
 The functions implementing the Initialization Check of the OutStream components. More...
 
#define CR_FW_OUTSTREAM_INITACTION   {&CrDaServerSocketInitAction,&CrDaServerSocketInitAction}
 The functions implementing the Initialization Action of the OutStream components. More...
 
#define CR_FW_OUTSTREAM_CONFIGCHECK   {&CrFwBaseCmpDefConfigCheck,&CrFwBaseCmpDefConfigCheck}
 The functions implementing the Configuration Check of the OutStream components. More...
 
#define CR_FW_OUTSTREAM_CONFIGACTION   {&CrFwOutStreamDefConfigAction,&CrFwOutStreamDefConfigAction}
 The functions implementing the Configuration Action of the OutStream components. More...
 
#define CR_FW_OUTSTREAM_SHUTDOWNACTION   {&CrDaServerSocketShutdownAction,&CrDaServerSocketShutdownAction}
 The functions implementing the Shutdown Action of the OutStream components. More...
 

Detailed Description

User-modifiable parameters for the OutStream components (see CrFwOutStream.h) of the Slave 1 Application of the CORDET Demo.

The parameters defined in this file determine the configuration of the OutStream Components. The value of these parameters cannot be changed dynamically.

The Slave 1 Application sends packets to the Master Application and re-routes packets to the Slave 2 Application. It therefore needs two OutStream instances. The physical connection to the Master Application and to the Slave 2 Application is through a server socket. The interface to the server socket is encapsulated in CrMaServerSocket.h.

Author
Vaclav Cechticky vacla.nosp@m.v.ce.nosp@m.chtic.nosp@m.ky@p.nosp@m.np-so.nosp@m.ftwa.nosp@m.re.co.nosp@m.m
Alessandro Pasetti paset.nosp@m.ti@p.nosp@m.np-so.nosp@m.ftwa.nosp@m.re.co.nosp@m.m

This file is part of the CORDET Framework.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

For information on alternative licensing, please contact P&P Software GmbH.

Definition in file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

Macro Definition Documentation

#define CR_FW_NOF_OUTSTREAM   2

The number of OutStream components in the application.

Normally, an application should instantiate one OutStream component for each destination to which a report or a command may be sent. The value of this constant must be smaller than the range of the CrFwCounterU1_t integer type.

Definition at line 47 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

#define CR_FW_OUTSTREAM_CONFIGACTION   {&CrFwOutStreamDefConfigAction,&CrFwOutStreamDefConfigAction}

The functions implementing the Configuration Action of the OutStream components.

The OutStream components are derived from the Base Component and they therefore inherit its Reset Procedure (see CrFwResetProc.h). The reset procedure must be configured with two actions: the Configuration Action and the Configuration Check. This constant defines the functions implementing the Configuration Actions for the the OutStream components. The items in the array must be function pointers of type: FwPrAction_t.

Function CrFwOutStreamDefConfigAction can be used as a default implementation for this function. This function resets the internal data structures for the OutStream. An application-specific Configuration Action should therefore include a call to this function.

Definition at line 176 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

#define CR_FW_OUTSTREAM_CONFIGCHECK   {&CrFwBaseCmpDefConfigCheck,&CrFwBaseCmpDefConfigCheck}

The functions implementing the Configuration Check of the OutStream components.

The OutStream components are derived from the Base Component and they therefore inherit its Reset Procedure (see CrFwResetProc.h). The reset procedure must be configured with two actions: the Configuration Action and the Configuration Check. This constant defines the functions implementing the Configuration Checks for the the OutStream components. The items in the array must be function pointers of type: FwPrAction_t. Function CrFwBaseCmpDefConfigCheck can be used as a default implementation for this function.

The Configuration Check function defined in this file is the one provided by the socket-based interface of CrDaServerSocket.h.

Definition at line 157 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

#define CR_FW_OUTSTREAM_DEST   {CR_DA_MASTER,CR_DA_SLAVE_2}

The destinations of the OutStream components.

The destination of an OutStream is the middleware node to which the OutStream sends its packet. Each OutStream has one (and only one) destination associated to it. A destination is defined by a non-negative integer. This array defines the destination of the i-th OutStream.

The destinations defined in this file are those used for the Slave 1 Application of the CORDET Demo.

Definition at line 74 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

#define CR_FW_OUTSTREAM_INITACTION   {&CrDaServerSocketInitAction,&CrDaServerSocketInitAction}

The functions implementing the Initialization Action of the OutStream components.

The OutStream components are derived from the Base Component and they therefore inherit its Initialization Procedure (see CrFwInitProc.h). The initialization procedure must be configured with two actions: the Initialization Action and the Initialization Check. This constant defines the functions implementing the Initialization Actions for the the OutStream components. The items in the array must be function pointers of type: FwPrAction_t.

Function CrFwOutStreamDefInitAction can be used as a default implementation for this function. This function initializes the internal data structures for the OutStream. An application-specific Initialization Action should therefore include a call to this function.

The Initialization Action function defined in this file is the one provided by the socket-based interface of CrDaServerSocket.h.

Definition at line 139 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

#define CR_FW_OUTSTREAM_INITCHECK   {&CrDaServerSocketInitCheck,&CrDaServerSocketInitCheck}

The functions implementing the Initialization Check of the OutStream components.

The OutStream components are derived from the Base Component and they therefore inherit its Initialization Procedure (see CrFwInitProc.h). The initialization procedure must be configured with two actions: the Initialization Action and the Initiation Check. This constant defines the functions implementing the Initialization Checks for the the OutStream components. The items in the array must be function pointers of type: FwPrAction_t. Function CrFwBaseCmpDefInitCheck can be used as a default implementation for this function.

The Initialization Check function defined in this file is the one provided by the socket-based interface of CrDaServerSocket.h.

Definition at line 117 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

#define CR_FW_OUTSTREAM_NOF_GROUPS   {1,1}

The number of groups of the OutStream components.

The number of groups must be a positive integer. This array defines the number of groups of the i-th OutStream.

The number of groups defined in this file are those used for the Slave 1 Application of the CORDET Demo.

Definition at line 84 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

#define CR_FW_OUTSTREAM_PCKTHANDOVER   {&CrDaServerSocketPcktHandover,&CrDaServerSocketPcktHandover}

The functions implementing the packet hand-over operations of the OutStream components.

Each OutStream component needs to be able to hand-over a packet to the middleware. The function implementing this packet hand-over operation is one of the adaptation points of the framework. This array defines the packet hand-over operations for the OutStream. The items in the arrays must be function pointers of type: CrFwPcktHandover_t. No default is defined at framework level for this function.

The packet handover functions defined in this file is the one provided by the socket-based interface of CrDaServerSocket.h.

Definition at line 99 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

#define CR_FW_OUTSTREAM_PQSIZE   {10,10}

The sizes of the packet queues in the OutStream component.

Each OutStream has one packet queue. This constant defines the size of the packet queue of the i-th OutStream. The size of the packet queue represents the maximum number of packets which may remain pending in the packet queue. The size of a packet queue must be a positive integer (i.e. it is not legal to define a zero-size packet queue).

The packet sizes defined in this file are those used for the Slave 1 Application of the CORDET Demo.

Definition at line 61 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

#define CR_FW_OUTSTREAM_SHUTDOWNACTION   {&CrDaServerSocketShutdownAction,&CrDaServerSocketShutdownAction}

The functions implementing the Shutdown Action of the OutStream components.

The OutStream components are derived from the Base Component and they therefore inherit its Shutdown Action (see CrFwBaseCmp.h). This constant defines the shutdown functions for the the OutStream components. The items in the array must be function pointers of type: FwSmAction_t.

Function CrFwOutStreamDefShutdownAction can be used as a default implementation for this function. This function releases the memory resources used by the OutStream. An application-specific Shutdown Action should therefore include a call to this function.

The Shutdown Action function defined in this file is the one provided by the socket-based interface of CrDaServerSocket.h.

Definition at line 195 of file cordetfw-examples/src/CrConfigDemoSlave1/CrFwOutStreamUserPar.h.

P&P Software GmbH, Copyright 2012-2013, All Rights Reserved