CORDET Framework - C2 Implementation
CrFwOutStream.h
Go to the documentation of this file.
1 
63 #ifndef CRFW_OUT_STREAM_H_
64 #define CRFW_OUT_STREAM_H_
65 
66 /* Include FW Profile Files */
67 #include "FwSmConstants.h"
68 #include "FwPrConstants.h"
69 /* Include Configuration Files */
70 #include "Pckt/CrFwPcktQueue.h"
71 #include "CrFwUserConstants.h"
72 /* Include Framework Files */
73 #include "CrFwConstants.h"
74 
101 FwSmDesc_t CrFwOutStreamMake(CrFwInstanceId_t outStreamId);
102 
109 CrFwBool_t CrFwOutStreamIsInReady(FwSmDesc_t smDesc);
110 
117 CrFwBool_t CrFwOutStreamIsInBuffering(FwSmDesc_t smDesc);
118 
138 
160 CrFwDestSrc_t CrFwOutStreamGetDest(FwSmDesc_t outStream, CrFwCounterU1_t i);
161 
170 CrFwCounterU1_t CrFwOutStreamGetNOfDest(FwSmDesc_t outStream);
171 
196 void CrFwOutStreamSend(FwSmDesc_t smDesc, CrFwPckt_t pckt);
197 
203 void CrFwOutStreamConnectionAvail(FwSmDesc_t smDesc);
204 
217 void CrFwOutStreamDefConfigAction(FwPrDesc_t prDesc);
218 
231 void CrFwOutStreamDefInitAction(FwPrDesc_t prDesc);
232 
243 void CrFwOutStreamDefShutdownAction(FwSmDesc_t smDesc);
244 
271 void CrFwOutStreamDefSetDTS(CrFwCounterU2_t* pNofTypeCounter,
272  CrFwDestTypeKey_t** destTypeKey);
273 
283 
293 
300 
306 
313 
319 
342 
359 
360 #endif /* CRFW_OUT_STREAM_H_ */
Header file to define all invariant publicly available constants and types for the CORDET Framework.
unsigned char * CrFwPckt_t
Type for packets (see CrFwPckt.h).
Definition: CrFwConstants.h:38
int CrFwBool_t
Type used for boolean values (1 represent "true" and 0 represents "false").
Definition: CrFwConstants.h:32
static CrFwServType_t servType
The InCommand type as computed in the Validity Check.
static CrFwDestSrc_t dest
Destination.
static CrFwServSubType_t servSubType
Service sub-type.
FwSmDesc_t CrFwOutStreamGet(CrFwDestSrc_t dest)
Getter function for the OutStream corresponding to the argument destination.
void CrFwOutStreamDefConfigAction(FwPrDesc_t prDesc)
Default configuration action for an OutStream.
void CrFwOutStreamDefInitAction(FwPrDesc_t prDesc)
Default initialization action for an OutStream.
CrFwCounterU2_t CrFwOutStreamGetNOfTypeCounters()
Return the number of type counters maintained by the OutStreams.
FwSmDesc_t CrFwOutStreamMake(CrFwInstanceId_t outStreamId)
Factory function to retrieve the i-th OutStream State Machine instance.
CrFwGroup_t CrFwOutStreamGetNOfGroups()
Return the number of groups associated to the OutStreams.
CrFwTypeCnt_t CrFwOutStreamGetTypeCounter(CrFwDestSrc_t dest, CrFwServType_t servType, CrFwServSubType_t servSubType)
Return the current type counter for a (destination, type, sub-type) triplet or zero if the triplet is...
void CrFwOutStreamDefShutdownAction(FwSmDesc_t smDesc)
Default shutdown action for an OutStream.
CrFwCounterU1_t CrFwOutStreamGetNOfPendingPckts(FwSmDesc_t smDesc)
Return the number of packets currently in the packet queue of an OutStream.
CrFwSeqCnt_t CrFwOutStreamGetSeqCnt(CrFwGroup_t group)
Return the value of the sequence counter for one of the groups maintained by the OutStreams.
CrFwBool_t CrFwOutStreamIsInReady(FwSmDesc_t smDesc)
Return true if the argument OutStream is in state READY.
void CrFwOutStreamSetSeqCnt(CrFwGroup_t group, CrFwSeqCnt_t seqCnt)
Sets the value of the sequence counter for one of the groups maintained by the OutStreams.
CrFwDestSrc_t CrFwOutStreamGetDest(FwSmDesc_t outStream, CrFwCounterU1_t i)
Return the i-th destination associated to the argument outStream.
CrFwCounterU1_t CrFwOutStreamGetNOfDest(FwSmDesc_t outStream)
Return the number of destinations associated to the argument outStream.
void CrFwOutStreamDefSetDTS(CrFwCounterU2_t *pNofTypeCounter, CrFwDestTypeKey_t **destTypeKey)
Default implementation of Set DST Function for the OutStreams.
CrFwCounterU1_t CrFwOutStreamGetPcktQueueSize(FwSmDesc_t smDesc)
Return the size of the packet queue of the OutStream.
void CrFwOutStreamConnectionAvail(FwSmDesc_t smDesc)
Signal that the out-going middleware connection has become available.
CrFwBool_t CrFwOutStreamIsInBuffering(FwSmDesc_t smDesc)
Return true if the argument OutStream is in state BUFFERING.
void CrFwOutStreamSend(FwSmDesc_t smDesc, CrFwPckt_t pckt)
Send a packet to the OutStream.
CrFwBool_t CrFwOutStreamIsInDtsSet(CrFwDestSrc_t dest, CrFwServType_t servType, CrFwServSubType_t servSubType)
Check whether the (destination, type, sub-type) triplet is in DTS_SET.
static CrFwSeqCnt_t seqCnt[CR_FW_OUTSTREAM_STUB_MEM_LEN]
Sequence counters of most recently received packets.
Definition and management of packet queues.
Header file to define all user-configurable constants and types for the CORDET Framework (the non-con...
unsigned int CrFwSeqCnt_t
Type used for the sequence counter of commands or reports.
unsigned char CrFwServType_t
Type used for the service type of a command or report.
unsigned char CrFwDestSrc_t
Type used for the command or report destination and source.
unsigned short CrFwCounterU2_t
Type used for unsigned integers with a "medium" range.
unsigned char CrFwCounterU1_t
Type used for unsigned integers with a "short" range.
unsigned int CrFwTypeCnt_t
Type used for the type counter of commands or reports.
unsigned char CrFwGroup_t
Type used for the destination or source group of a packet.
unsigned int CrFwDestTypeKey_t
Type for the destination type key in CrFwOutStream.c.
unsigned short CrFwInstanceId_t
Type used for instance identifiers.
unsigned char CrFwServSubType_t
Type used for the command or report sub-type.
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved