CORDET Framework - C2 Implementation
|
User-modifiable parameters for the InStream components (see CrFwInStream.h
).
More...
Go to the source code of this file.
Macros | |
#define | CR_FW_NOF_INSTREAM 7 |
The number of InStream components in the application. More... | |
#define | CR_FW_INSTREAM_PQSIZE {3,3,3,3,5,6,7} |
The sizes of the packet queues in the InStream components. More... | |
#define | CR_FW_INSTREAM_NOF_GROUPS {1,1,2,1,1,1,1} |
The number of groups of the InStream components. More... | |
#define | CR_FW_INSTREAM_SRC {1,2,3,4,5,10,10} |
The packet source which is managed by the InStream component. More... | |
#define | CR_FW_INSTREAM_PCKTCOLLECT |
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... | |
User-modifiable parameters for the InStream components (see CrFwInStream.h
).
This file defines all the user-modifiable parameters for the InStream. Users will normally have to modify this file as part of framework instantiation process.
The parameters defined in this file determine the configuration of the InStream Components. The value of these parameters cannot be changed dynamically.
The default values defined in this file are those used for the testing of the CORDET Framework.
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/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_CONFIGACTION |
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 first three Configuration Action functions defined in this file are the default Configuration Action functions CrFwInStreamDefConfigAction
offered by the InStream component. The fourth Configuration Action which is defined in the stub InStream of CrFwInStreamStub.h
and it is used to verify initialization failures. The last Configuration Action is defined in the Socket-Based InStream of CrFwInStreamSocket.h
. Applications may need to use different functions which also cover the configuration of the middleware.
Definition at line 257 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_CONFIGCHECK |
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.
The Configuration Check functions defined in this file are the default Configuration Check functions CrFwBaseCmpDefConfigCheck
offered by the Base Component with the exception of the fourth Configuration Check which is defined in the test suite as a dummy check to verify configuration failures. Applications may need to use different functions which also cover the configuration of the middleware.
Definition at line 222 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_INITACTION |
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 first three Initialization Action functions defined in this file are the default Initialization Action functions CrFwInStreamDefInitAction
offered by the InStream component. The fourth Initialization Action is defined in the stub InStream of CrFwInStreamStub.h
and it is used to verify initialization failures. The last Initialization Action is defined in the Socket-Based InStream of CrFwInStreamSocket.h
. Applications may need to use different functions which also include the initialization of the middleware.
Definition at line 192 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_INITCHECK |
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 functions defined for the first 3 InStreams are the default Initialization Check functions CrFwBaseCmpDefInitCheck
offered by the base component. The fourth Initialization Check is defined in the stub InStream of CrFwInStreamStub.h
and it is used to verify initialization check failures. The last Initialization Check is defined in the Socket-Based InStream of CrFwInStreamSocket.h
. Applications may need to use different functions which also cover the initialization of the middleware.
Definition at line 157 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_NOF_GROUPS {1,1,2,1,1,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 test cases of CrFwInStreamTestCases.h
.
Definition at line 71 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_PCKTAVAILCHECK |
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 available check operations defined in this file are the ones provided by the InStream stub of CrFwInStreamStub.h
and by the socket-based InStream of CrFwInStreamSocket.h
.
Definition at line 125 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_PCKTCOLLECT |
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 InStream. The items in the arrays must be function pointers of type: CrFwPcktCollect_t
.
The packet collection operations defined in this file are the ones provided by the InStream stub of CrFwInStreamStub.h
and by the socket-based InStream of CrFwInStreamSocket.h
.
Definition at line 101 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_PQSIZE {3,3,3,3,5,6,7} |
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).
The packet queue sizes defined in this file are those used for the test cases of CrFwInStreamTestCases.h
.
Definition at line 61 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_SHUTDOWNACTION |
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 first, the third and the fourth Shutdown Action functions defined in this file are the default Shutdown Action functions CrFwInStreamDefShutdownAction
offered by the InStream component. The second shutdown action is defined in the stub InStream of CrFwInStreamStub.h
and it is used to verify initialization failures. The last Shutdown Action is defined in the Socket-Based InStream of CrFwInStreamSocket.h
. Applications may need to use different functions which also cover the shutdown of the middleware.
Definition at line 290 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_INSTREAM_SRC {1,2,3,4,5,10,10} |
The packet source which is managed by the InStream component.
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.
The packet sources defined in this file are those used for the test cases of CrFwInStreamTestCases.h
. The packet source of the last two InStreams must be the same as the host application identifier (CR_FW_HOST_APP_ID
); this is normally illegal but is required for a correct functioning of the socket test cases in CrFwSocketTestCases.h
.
Definition at line 86 of file cordetfw/tests/config/CrFwInStreamUserPar.h.
#define CR_FW_NOF_INSTREAM 7 |
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.
The number of InStream components defined in this file is the one used for the test cases of CrFwInStreamTestCases.h
.
Definition at line 47 of file cordetfw/tests/config/CrFwInStreamUserPar.h.