CORDET Framework - C2 Implementation
CrFwInStream.h
Go to the documentation of this file.
1 
59 #ifndef CRFW_INSTREAM_H_
60 #define CRFW_INSTREAM_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 CrFwInStreamMake(CrFwInstanceId_t inStreamId);
89 
108 FwSmDesc_t CrFwInStreamGet(CrFwDestSrc_t src);
109 
121 CrFwPckt_t CrFwInStreamGetPckt(FwSmDesc_t smDesc);
122 
133 void CrFwInStreamPcktAvail(FwSmDesc_t smDesc);
134 
141 CrFwBool_t CrFwInStreamIsInWaiting(FwSmDesc_t smDesc);
142 
149 CrFwBool_t CrFwInStreamIsInPcktAvail(FwSmDesc_t smDesc);
150 
163 void CrFwInStreamDefConfigAction(FwPrDesc_t prDesc);
164 
178 void CrFwInStreamDefInitAction(FwPrDesc_t prDesc);
179 
190 void CrFwInStreamDefShutdownAction(FwSmDesc_t smDesc);
191 
201 
210 
217 
223 
230 
248 CrFwDestSrc_t CrFwInStreamGetSrc(FwSmDesc_t smDesc, CrFwCounterU1_t i);
249 CrFwCounterU1_t CrFwInStreamGetNOfSrc(FwSmDesc_t smDesc);
261 
262 #endif /* CRFW_INSTREAM_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
void CrFwInStreamDefInitAction(FwPrDesc_t prDesc)
Default initialization action for an InStream.
Definition: CrFwInStream.c:324
CrFwBool_t CrFwInStreamIsInWaiting(FwSmDesc_t smDesc)
Return true if the argument InStream is in state WAITING.
Definition: CrFwInStream.c:243
CrFwCounterU1_t CrFwInStreamGetNOfSrc(FwSmDesc_t smDesc)
Get the number of packet sources of the argument InStream.
Definition: CrFwInStream.c:236
CrFwCounterU1_t CrFwInStreamGetPcktQueueSize(FwSmDesc_t smDesc)
Return the size of the packet queue of the InStream.
Definition: CrFwInStream.c:291
CrFwCounterU1_t CrFwInStreamGetNOfPendingPckts(FwSmDesc_t smDesc)
Return the number of packets currently in the packet queue of an InStream.
Definition: CrFwInStream.c:279
CrFwPckt_t CrFwInStreamGetPckt(FwSmDesc_t smDesc)
Retrieve a packet from the InStream.
Definition: CrFwInStream.c:253
CrFwBool_t CrFwInStreamIsInPcktAvail(FwSmDesc_t smDesc)
Return true if the argument InStream is in state PCKT_AVAIL.
Definition: CrFwInStream.c:248
void CrFwInStreamDefConfigAction(FwPrDesc_t prDesc)
Default configuration action for an InStream.
Definition: CrFwInStream.c:298
void CrFwInStreamSetSeqCnt(CrFwGroup_t group, CrFwSeqCnt_t seqCnt)
Overwrites the sequence counter value of the last packet for a group.
Definition: CrFwInStream.c:273
CrFwDestSrc_t CrFwInStreamGetSrc(FwSmDesc_t smDesc, CrFwCounterU1_t i)
Get the i-th packet source of the argument InStream.
Definition: CrFwInStream.c:228
FwSmDesc_t CrFwInStreamGet(CrFwDestSrc_t src)
Getter function for the InStream corresponding to the argument source.
Definition: CrFwInStream.c:217
CrFwGroup_t CrFwInStreamGetNOfGroups()
Return the number of groups managed by the InStreams.
Definition: CrFwInStream.c:286
void CrFwInStreamDefShutdownAction(FwSmDesc_t smDesc)
Default shutdown action for an InStream.
Definition: CrFwInStream.c:311
CrFwSeqCnt_t CrFwInStreamGetSeqCnt(CrFwGroup_t group)
Return the value of the sequence counter of the last packet successfully collected by the InStreams f...
Definition: CrFwInStream.c:267
FwSmDesc_t CrFwInStreamMake(CrFwInstanceId_t inStreamId)
Factory function to retrieve the i-th InStream State Machine instance.
Definition: CrFwInStream.c:128
void CrFwInStreamPcktAvail(FwSmDesc_t smDesc)
Query the middleware for available packets and collect them if they are available.
Definition: CrFwInStream.c:262
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 CrFwDestSrc_t
Type used for the command or report destination and source.
unsigned char CrFwCounterU1_t
Type used for unsigned integers with a "short" range.
unsigned char CrFwGroup_t
Type used for the destination or source group of a packet.
unsigned short CrFwInstanceId_t
Type used for instance identifiers.
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved