JAUS Message Header Structure used by the Transport Services. More...
#include <header.h>
Classes | |
| class | AckNack |
| Class containing constants for acknowledgement or negative acknowledgment of message receipt. More... | |
| class | Broadcast |
| Class containing constants for broadcast flags. More... | |
| class | Compression |
| Class containing constants for header compression flags. More... | |
| class | DataControl |
| Class containing constants for different types of data control values. More... | |
| class | MessageType |
| Class containing constants for message type flags used in the header. More... | |
| class | Priority |
| Class containing constants for different types of priority values in the JAUS transport header. More... | |
Public Types | |
| typedef std::vector< Header > | List |
| Vector of Header data. | |
Public Member Functions | |
| Header () | |
| Constructor, initializes default values. | |
| Header (const Header &header) | |
| Copy constructor. | |
| ~Header () | |
| Destructor. | |
| int | Write (Packet &packet) const |
| Writes header data to a packet for transmission. | |
| int | Read (const Packet &packet) |
| Reads header data from the current read position in the packet. | |
| bool | IsValid (std::string *errorMessage) const |
| Checks for valid header data. | |
| Header & | operator= (const Header &header) |
| Sets equal to. | |
Public Attributes | |
| Byte | mMessageType |
| Type of message being sent through transport layer (does not indicate payload type). | |
| Address | mDestinationID |
| Destination ID/Address. | |
| Address | mSourceID |
| Source ID/Address. | |
| UShort | mSequenceNumber |
| Sequence number of packet (used for multi-packet streams). | |
| UShort | mSize |
| Size of the transport packet including general header in bytes. | |
| Byte | mPriorityFlag |
| Message priority flag. | |
| Byte | mBroadcastFlag |
| Broadcast flag. | |
| Byte | mAckNackFlag |
| ACK/NACK flag. | |
| Byte | mControlFlag |
| Data control flags (single or mulit-packet streams). | |
| Byte | mCompressionFlag |
| Header compression bits (header compression not supported by JAUS++). | |
Static Public Attributes | |
| static const UShort | MinSize = 14 |
| Minimum header size. | |
| static const UShort | PayloadOffset = MinSize - USHORT_SIZE |
| Offset from start of general header to payload. | |
| static const UShort | MaxPacketSize = JAUS_USHORT_MAX |
| Maximum packet size including header. | |
JAUS Message Header Structure used by the Transport Services.
The JAUS Transport header is defined by the AS5669A Standard.
Definition at line 59 of file header.h.
| typedef std::vector<Header> JAUS::Header::List |
| Header::Header | ( | ) |
Constructor, initializes default values.
Definition at line 51 of file header.cpp.
| Header::Header | ( | const Header & | header ) |
Copy constructor.
Definition at line 68 of file header.cpp.
| Header::~Header | ( | ) |
Destructor.
Definition at line 79 of file header.cpp.
| bool Header::IsValid | ( | std::string * | errorMessage ) | const |
Checks for valid header data.
| [out] | errorMessage | If not NULL, then the reason for a header being invalid is saved to this string. |
Definition at line 172 of file header.cpp.
Sets equal to.
Definition at line 230 of file header.cpp.
| int Header::Read | ( | const Packet & | packet ) |
Reads header data from the current read position in the packet.
| [in] | packet | The packet to read from. |
Definition at line 130 of file header.cpp.
| int Header::Write | ( | Packet & | packet ) | const |
Writes header data to a packet for transmission.
Writes from the current Write Position in the packet.
| [out] | packet | The packet to write to. |
Definition at line 95 of file header.cpp.
const UShort JAUS::Header::MaxPacketSize = JAUS_USHORT_MAX [static] |
const UShort JAUS::Header::MinSize = 14 [static] |
const UShort JAUS::Header::PayloadOffset = MinSize - USHORT_SIZE [static] |
1.7.2
