CORDET Framework - C2 Implementation
CrFwPcktQueue.h
Go to the documentation of this file.
1 
35 #ifndef CRFW_PACKETQUEUE_H_
36 #define CRFW_PACKETQUEUE_H_
37 
38 /* Include Framework Files */
39 #include "CrFwConstants.h"
40 /* Include Configuration Files */
41 #include "CrFwUserConstants.h"
42 
52 
62 
74 
88 
95 void CrFwPcktQueueReset(CrFwPcktQueue_t pcktQueue);
96 
104 void CrFwPcktQueueShutdown(CrFwPcktQueue_t pcktQueue);
105 
112 
119 
126 
127 #endif /* CRFW_PACKETQUEUE_H_ */
unsigned char CrFwCounterU1_t
Type used for unsigned integers with a "short" range.
CrFwPckt_t * pckt
The list of packets in the PQ.
CrFwBool_t CrFwPcktQueuePush(CrFwPcktQueue_t pcktQueue, CrFwPckt_t pckt)
Push a packet onto the packet queue.
Definition: CrFwPcktQueue.c:52
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
Descriptor for a Packet Queue (PQ) in an OutStream or InStream.
Header file to define all invariant publicly available constants and types for the CORDET Framework...
CrFwPckt_t CrFwPcktQueuePop(CrFwPcktQueue_t pcktQueue)
Pop a packet from the packet queue.
Definition: CrFwPcktQueue.c:25
CrFwCounterU1_t CrFwPcktQueueGetSize(CrFwPcktQueue_t pcktQueue)
Return the size of the packet queue.
void CrFwPcktQueueReset(CrFwPcktQueue_t pcktQueue)
Reset the packet queue.
Definition: CrFwPcktQueue.c:73
CrFwCounterU1_t size
The size of the PQ (the same as the size of the pckt array)
void CrFwPcktQueueShutdown(CrFwPcktQueue_t pcktQueue)
Shutdown the packet queue.
CrFwPckt_t CrFwPcktQueueGetOldest(CrFwPcktQueue_t pcktQueue)
Return the oldest packet from the queue without removing it from the queue.
Definition: CrFwPcktQueue.c:44
CrFwCounterU1_t CrFwPcktQueueGetNOfPckts(CrFwPcktQueue_t pcktQueue)
Return the number of packets currently in the packet queue.
Header file to define all user-configurable constants and types for the CORDET Framework (the non-con...
void CrFwPcktQueueInit(CrFwPcktQueue_t pcktQueue, CrFwCounterU1_t size)
Initializes the packet queue.
Definition: CrFwPcktQueue.c:95
CrFwBool_t CrFwPcktQueueIsEmpty(CrFwPcktQueue_t pcktQueue)
Return 1 if the packet queue is empty and 0 otherwise.
P&P Software GmbH, Copyright 2012-2013, All Rights Reserved