Detailed Description
PacketQueue is a subclass of ByteQueue that is used to convert from raw bytes into IDBluePacket objects.
Member Function Documentation
Determine if the given packet is a valid IDBLUE packet
- Parameters:
-
packet | The packet to validate |
- Returns:
- TRUE if the packet is valid, FALSE otherwise
Create an IDBLuePacket from the ByteQueue at the given index
- Parameters:
-
index | The index in the ByteQueue to check for a packet |
- Returns:
- An IDBluePacket if the data starting at index is a valid packet. Otherwise, returns nil.
In the event the ByteQueue contains invalid data (i.e. data is not formatted as proper IDBLUE packets), remove data from the start of the ByteQueue so that the ByteQueue contains only valid IDBLUE packets.
- Returns:
- The number of bytes removed from the start of the ByteQueue.
The documentation for this class was generated from the following files: