CORDET Framework - C2 Implementation
CrFwInStream.h
Go to the documentation of this file.
1 
61 #ifndef CRFW_INSTREAM_H_
62 #define CRFW_INSTREAM_H_
63 
64 /* Include FW Profile Files */
65 #include "FwSmConstants.h"
66 #include "FwPrConstants.h"
67 /* Include Configuration Files */
68 #include "Pckt/CrFwPcktQueue.h"
69 #include "CrFwUserConstants.h"
70 /* Include Framework Files */
71 #include "CrFwConstants.h"
72 
90 FwSmDesc_t CrFwInStreamMake(CrFwInstanceId_t inStreamId);
91 
110 FwSmDesc_t CrFwInStreamGet(CrFwDestSrc_t src);
111 
123 CrFwPckt_t CrFwInStreamGetPckt(FwSmDesc_t smDesc);
124 
135 void CrFwInStreamPcktAvail(FwSmDesc_t smDesc);
136 
143 CrFwBool_t CrFwInStreamIsInWaiting(FwSmDesc_t smDesc);
144 
151 CrFwBool_t CrFwInStreamIsInPcktAvail(FwSmDesc_t smDesc);
152 
164 void CrFwInStreamDefConfigAction(FwPrDesc_t prDesc);
165 
181 void CrFwInStreamDefInitAction(FwPrDesc_t prDesc);
182 
193 void CrFwInStreamDefShutdownAction(FwSmDesc_t smDesc);
194 
204 CrFwSeqCnt_t CrFwInStreamGetSeqCnt(FwSmDesc_t smDesc, CrFwGroup_t group);
205 
214 void CrFwInStreamSetSeqCnt(FwSmDesc_t smDesc, CrFwGroup_t group, CrFwSeqCnt_t seqCnt);
215 
222 
228 CrFwGroup_t CrFwInStreamGetNOfGroups(FwSmDesc_t smDesc);
229 
236 
244 CrFwDestSrc_t CrFwInStreamGetSrc(FwSmDesc_t smDesc);
245 
246 #endif /* CRFW_INSTREAM_H_ */
unsigned char CrFwCounterU1_t
Type used for unsigned integers with a "short" range.
unsigned short CrFwInstanceId_t
Type used for instance identifiers.
CrFwDestSrc_t CrFwInStreamGetSrc(FwSmDesc_t smDesc)
Get the currently defined packet source of an InStream.
Definition: CrFwInStream.c:246
void CrFwInStreamDefShutdownAction(FwSmDesc_t smDesc)
Default shutdown action for an InStream.
Definition: CrFwInStream.c:301
CrFwBool_t CrFwInStreamIsInPcktAvail(FwSmDesc_t smDesc)
Return true if the argument InStream is in state PCKT_AVAIL.
Definition: CrFwInStream.c:227
unsigned char * CrFwPckt_t
Type for packets (see CrFwPckt.h).
Definition: CrFwConstants.h:38
CrFwCounterU1_t CrFwInStreamGetPcktQueueSize(FwSmDesc_t smDesc)
Return the size of the packet queue of the InStream.
Definition: CrFwInStream.c:281
void CrFwInStreamSetSeqCnt(FwSmDesc_t smDesc, CrFwGroup_t group, CrFwSeqCnt_t seqCnt)
Overwrites the sequence counter value of the last packet for a group.
Definition: CrFwInStream.c:260
int CrFwBool_t
Type used for boolean values (1 represent "true" and 0 represents "false").
Definition: CrFwConstants.h:32
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...
CrFwGroup_t CrFwInStreamGetNOfGroups(FwSmDesc_t smDesc)
Return the number of groups associated to the InStream.
Definition: CrFwInStream.c:275
unsigned char CrFwDestSrc_t
Type used for the command or report destination and source.
void CrFwInStreamDefConfigAction(FwPrDesc_t prDesc)
Default configuration action for an InStream.
Definition: CrFwInStream.c:288
CrFwSeqCnt_t CrFwInStreamGetSeqCnt(FwSmDesc_t smDesc, CrFwGroup_t group)
Return the value of the sequence counter of the last packet successfully collected by the InStream fo...
Definition: CrFwInStream.c:253
CrFwPckt_t CrFwInStreamGetPckt(FwSmDesc_t smDesc)
Retrieve a packet from the InStream.
Definition: CrFwInStream.c:232
CrFwCounterU1_t CrFwInStreamGetNOfPendingPckts(FwSmDesc_t smDesc)
Return the number of packets currently in the packet queue of an InStream.
Definition: CrFwInStream.c:268
Definition and management of packet queues.
FwSmDesc_t CrFwInStreamMake(CrFwInstanceId_t inStreamId)
Factory function to retrieve the i-th InStream State Machine instance.
Definition: CrFwInStream.c:121
void CrFwInStreamDefInitAction(FwPrDesc_t prDesc)
Default initialization action for an InStream.
Definition: CrFwInStream.c:312
Header file to define all user-configurable constants and types for the CORDET Framework (the non-con...
void CrFwInStreamPcktAvail(FwSmDesc_t smDesc)
Query the middleware for available packets and collect them if they are available.
Definition: CrFwInStream.c:241
CrFwBool_t CrFwInStreamIsInWaiting(FwSmDesc_t smDesc)
Return true if the argument InStream is in state WAITING.
Definition: CrFwInStream.c:222
FwSmDesc_t CrFwInStreamGet(CrFwDestSrc_t src)
Getter function for the InStream corresponding to the argument source.
Definition: CrFwInStream.c:211
unsigned int CrFwSeqCnt_t
Type used for the sequence counter of commands or reports.
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved