jaus++/2.0/include/jaus/core/header.h

Go to the documentation of this file.

#ifndef __JAUS_CORE_HEADER__H
#define __JAUS_CORE_HEADER__H

#include "jaus/core/address.h"
#include <string>
#include <vector>
#include <cxutils/packet.h>

namespace JAUS
{
    class JAUS_CORE_DLL Header
    {
    public:
        class Priority
        {
        public:
            const static Byte Low             = 0;       
            const static Byte Standard        = 1;       
            const static Byte High            = 2;       
            const static Byte SafetyCritical  = 3;       
        };
        class DataControl
        {
        public:
            const static Byte Single      = 0;    
            const static Byte First       = 1;    
            const static Byte Normal      = 2;    
            const static Byte Last        = 3;    
        };
        class MessageType
        {
        public:
            const static Byte Normal       = 0;   
        };  
        class AckNack
        {
        public:
            const static Byte None         = 0;   
            const static Byte Request      = 1;   
            const static Byte Nack         = 2;   
            const static Byte Ack          = 3;   
        };
        class Broadcast
        {
        public:
            const static UShort None         = 0;   
            const static UShort Local        = 1;   
            const static UShort Global       = 2;   
        };
        class Compression
        {
        public:
            const static Byte None          = 0;    
            const static Byte Request       = 1;    
        };
        static const UShort MinSize    = 14;                       
        static const UShort PayloadOffset = MinSize - USHORT_SIZE; 
        static const UShort MaxPacketSize = JAUS_USHORT_MAX;       
        typedef std::vector<Header> List;                          
        Header();
        Header(const Header& header);
        ~Header();
        int Write(Packet& packet) const;
        int Read(const Packet& packet);
        bool IsValid(std::string* errorMessage) const;
        Header& operator=(const Header& header);
        Byte mMessageType;      
        Address mDestinationID; 
        Address mSourceID;      
        UShort mSequenceNumber; 
        UShort mSize;           
        Byte mPriorityFlag;     
        Byte mBroadcastFlag;    
        Byte mAckNackFlag;      
        Byte mControlFlag;      
        Byte mCompressionFlag;  

    };
}

#endif

/*  End of File */