CORDET Framework - C2 Implementation
CrFwOutStream.h
Go to the documentation of this file.
1 
59 #ifndef CRFW_OUT_STREAM_H_
60 #define CRFW_OUT_STREAM_H_
61 
62 /* Include FW Profile Files */
63 #include "FwSmConstants.h"
64 #include "FwPrConstants.h"
65 /* Include Configuration Files */
66 #include "Pckt/CrFwPcktQueue.h"
67 #include "CrFwUserConstants.h"
68 /* Include Framework Files */
69 #include "CrFwConstants.h"
70 
88 FwSmDesc_t CrFwOutStreamMake(CrFwInstanceId_t outStreamId);
89 
96 CrFwBool_t CrFwOutStreamIsInReady(FwSmDesc_t smDesc);
97 
104 CrFwBool_t CrFwOutStreamIsInBuffering(FwSmDesc_t smDesc);
105 
125 
150 void CrFwOutStreamSend(FwSmDesc_t smDesc, CrFwPckt_t pckt);
151 
157 void CrFwOutStreamConnectionAvail(FwSmDesc_t smDesc);
158 
171 void CrFwOutStreamDefConfigAction(FwPrDesc_t prDesc);
172 
188 void CrFwOutStreamDefInitAction(FwPrDesc_t prDesc);
189 
200 void CrFwOutStreamDefShutdownAction(FwSmDesc_t smDesc);
201 
207 CrFwDestSrc_t CrFwOutStreamGetDest(FwSmDesc_t smDesc);
208 
218 CrFwSeqCnt_t CrFwOutStreamGetSeqCnt(FwSmDesc_t smDesc, CrFwGroup_t group);
219 
229 void CrFwOutStreamSetSeqCnt(FwSmDesc_t smDesc, CrFwGroup_t group, CrFwSeqCnt_t seqCnt);
230 
237 
243 CrFwGroup_t CrFwOutStreamGetNOfGroups(FwSmDesc_t smDesc);
244 
251 
252 #endif /* CRFW_OUT_STREAM_H_ */
unsigned char CrFwCounterU1_t
Type used for unsigned integers with a "short" range.
unsigned short CrFwInstanceId_t
Type used for instance identifiers.
CrFwCounterU1_t CrFwOutStreamGetPcktQueueSize(FwSmDesc_t smDesc)
Return the size of the packet queue of the OutStream.
CrFwBool_t CrFwOutStreamIsInReady(FwSmDesc_t smDesc)
Return true if the argument OutStream is in state READY.
unsigned char * CrFwPckt_t
Type for packets (see CrFwPckt.h).
Definition: CrFwConstants.h:38
void CrFwOutStreamDefConfigAction(FwPrDesc_t prDesc)
Default configuration action for an OutStream.
CrFwCounterU1_t CrFwOutStreamGetNOfPendingPckts(FwSmDesc_t smDesc)
Return the number of packets currently in the packet queue of an OutStream.
void CrFwOutStreamDefShutdownAction(FwSmDesc_t smDesc)
Default shutdown action for an OutStream.
CrFwBool_t CrFwOutStreamIsInBuffering(FwSmDesc_t smDesc)
Return true if the argument OutStream is in state BUFFERING.
int CrFwBool_t
Type used for boolean values (1 represent "true" and 0 represents "false").
Definition: CrFwConstants.h:32
FwSmDesc_t CrFwOutStreamMake(CrFwInstanceId_t outStreamId)
Factory function to retrieve the i-th OutStream State Machine instance.
unsigned char CrFwGroup_t
Type used for the destination or source group of a packet.
Header file to define all invariant publicly available constants and types for the CORDET Framework...
unsigned char CrFwDestSrc_t
Type used for the command or report destination and source.
Definition and management of packet queues.
void CrFwOutStreamConnectionAvail(FwSmDesc_t smDesc)
Signal that the out-going middleware connection has become available.
CrFwGroup_t CrFwOutStreamGetNOfGroups(FwSmDesc_t smDesc)
Return the number of groups associated to the OutStream.
static CrFwDestSrc_t dest
Destination.
Header file to define all user-configurable constants and types for the CORDET Framework (the non-con...
CrFwDestSrc_t CrFwOutStreamGetDest(FwSmDesc_t smDesc)
Get the destination for an OutStream.
void CrFwOutStreamDefInitAction(FwPrDesc_t prDesc)
Default initialization action for an OutStream.
void CrFwOutStreamSetSeqCnt(FwSmDesc_t smDesc, CrFwGroup_t group, CrFwSeqCnt_t seqCnt)
Sets the value of the sequence counter for one of the groups maintained by an OutStream.
CrFwSeqCnt_t CrFwOutStreamGetSeqCnt(FwSmDesc_t smDesc, CrFwGroup_t group)
Return the value of the sequence counter for one of the groups maintained by an OutStream.
void CrFwOutStreamSend(FwSmDesc_t smDesc, CrFwPckt_t pckt)
Send a packet to the OutStream.
unsigned int CrFwSeqCnt_t
Type used for the sequence counter of commands or reports.
FwSmDesc_t CrFwOutStreamGet(CrFwDestSrc_t dest)
Getter function for the OutStream corresponding to the argument destination.
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved