CORDET Framework - C2 Implementation
cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h File Reference

User-modifiable parameters for the InStream components (see CrFwInStream.h) of the Master Application of the CORDET Demo. More...

Go to the source code of this file.

Macros

#define CR_FW_NOF_INSTREAM   2
 The number of InStream components in the application. More...
 
#define CR_FW_INSTREAM_PQSIZE   {10,10}
 The sizes of the packet queues in the InStream components. More...
 
#define CR_FW_INSTREAM_SRC   {CR_DA_SLAVE_1,CR_DA_SLAVE_2}
 The packet sources which are managed by the InStream components. More...
 
#define CR_FW_INSTREAM_NOF_GROUPS   {1,1}
 The number of groups of the InStream components. More...
 
#define CR_FW_INSTREAM_PCKTCOLLECT   {&CrDaClientSocketPcktCollect, &CrDaClientSocketPcktCollect}
 The functions implementing the Packet Collect Operations of the InStream components. More...
 
#define CR_FW_INSTREAM_PCKTAVAILCHECK
 The functions implementing the Packet Available Check Operations of the InStream components. More...
 
#define CR_FW_INSTREAM_INITCHECK
 The functions implementing the Initialization Check of the InStream components. More...
 
#define CR_FW_INSTREAM_INITACTION
 The functions implementing the Initialization Action of the InStream components. More...
 
#define CR_FW_INSTREAM_CONFIGCHECK
 The functions implementing the Configuration Check of the InStream components. More...
 
#define CR_FW_INSTREAM_CONFIGACTION
 The functions implementing the Configuration Action of the InStream components. More...
 
#define CR_FW_INSTREAM_SHUTDOWNACTION
 The functions implementing the Shutdown Action of the InStream components. More...
 

Detailed Description

User-modifiable parameters for the InStream components (see CrFwInStream.h) of the Master Application of the CORDET Demo.

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

The Master Application receives packets from the two Slave Applications. It therefore needs two InStream instances. The physical connection to the two Slave Applications is through a client socket. The interface to the client socket is encapsulated in CrMaClientSocket.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/CrConfigDemoMaster/CrFwInStreamUserPar.h.

Macro Definition Documentation

#define CR_FW_INSTREAM_CONFIGACTION
Value:
void CrDaClientSocketConfigAction(FwPrDesc_t prDesc)
Configuration action for the client socket.

The functions implementing the Configuration Action of the InStream components.

The InStream 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 InStream components. The items in the array must be function pointers of type: FwPrAction_t.

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

The configuration action operation defined in this file is the one provided by the socket-based interface of CrDaClientSocket.h.

Definition at line 186 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_INSTREAM_CONFIGCHECK
Value:
void CrFwBaseCmpDefConfigCheck(FwPrDesc_t prDesc)
Function which performs the default Configuration Check of the CRP.
Definition: CrFwResetProc.c:33

The functions implementing the Configuration Check of the InStream components.

The InStream 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 InStream 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.

Definition at line 163 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_INSTREAM_INITACTION
Value:
void CrDaClientSocketInitAction(FwPrDesc_t prDesc)
Initialization action for the client socket.

The functions implementing the Initialization Action of the InStream components.

The InStream 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 InStream components. The items in the array must be function pointers of type: FwPrAction_t.

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

The initialization check operation defined in this file is the one provided by the socket-based interface of CrDaClientSocket.h.

Definition at line 146 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_INSTREAM_INITCHECK
Value:
void CrDaClientSocketInitCheck(FwPrDesc_t prDesc)
Initialization check for the client socket.

The functions implementing the Initialization Check of the InStream components.

The InStream 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 Checks for the the InStream 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 operation defined in this file is the one provided by the socket-based interface of CrDaClientSocket.h.

Definition at line 123 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_INSTREAM_NOF_GROUPS   {1,1}

The number of groups of the InStream components.

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

The number of groups defined in this file are those used for the Master Application.

Definition at line 72 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_INSTREAM_PCKTAVAILCHECK
Value:
CrFwBool_t CrDaClientSocketIsPcktAvail(CrFwDestSrc_t src)
Function implementing the Packet Available Check Operation for the client socket. ...

The functions implementing the Packet Available Check Operations of the InStream components.

Each InStream component needs to be able to check whether the middleware is in state WAITING (no packet is available for collection) or PCKT_AVAIL (a packet is available for collection). The functions which query the middleware to check whether a packet is available or not is one of the adaptation points of the framework. This array defines the Packet Available Check Operations for the InStream. The items in the array must be function pointers of type: CrFwPcktAvailCheck_t.

The packet collection operation defined in this file is the one provided by the socket-based interface of CrDaClientSocket.h.

Definition at line 103 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_INSTREAM_PCKTCOLLECT   {&CrDaClientSocketPcktCollect, &CrDaClientSocketPcktCollect}

The functions implementing the Packet Collect Operations of the InStream components.

Each InStream component needs to be able to collect a packet from the middleware. The function implementing this packet collect operation is one of the adaptation points of the framework. This array defines the packet collect operations for the InStreams. The items in the arrays must be function pointers of type: CrFwPcktCollect_t.

The packet collection operation defined in this file is the one provided by the socket-based interface of CrDaClientSocket.h.

Definition at line 86 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_INSTREAM_PQSIZE   {10,10}

The sizes of the packet queues in the InStream components.

Each InStream has one packet queue. This constant defines the size of the packet queue of the i-th InStream. 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).

Definition at line 55 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_INSTREAM_SHUTDOWNACTION
Value:
void CrDaClientSocketShutdownAction(FwSmDesc_t smDesc)
Shutdown action for the client socket.

The functions implementing the Shutdown Action of the InStream components.

The InStream 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 InStream components. The items in the array must be function pointers of type: FwSmAction_t.

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

The shutdown action operation defined in this file is the one provided by the socket-based interface of CrDaClientSocket.h.

Definition at line 206 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_INSTREAM_SRC   {CR_DA_SLAVE_1,CR_DA_SLAVE_2}

The packet sources which are managed by the InStream components.

Each InStream is responsible for collecting packets from one packet source. This constant is the initializer for the array which defines the packet source associated to the i-th InStream.

Definition at line 63 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

#define CR_FW_NOF_INSTREAM   2

The number of InStream components in the application.

The value of this constant must be smaller than the range of the CrFwCounterU1_t integer type.

Definition at line 44 of file cordetfw-examples/src/CrConfigDemoMaster/CrFwInStreamUserPar.h.

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