DatagramDefs.hxx

Go to the documentation of this file.

 
#ifndef _OPENLCB_DATAGRAMDEFS_HXX_
#define _OPENLCB_DATAGRAMDEFS_HXX_
 
#include <stdint.h>
 
namespace openlcb
{
 
struct DatagramDefs
{
    enum Protocol
    {
        LOG_REQUEST   = 0x01, 
        LOG_REPLY     = 0x02, 
        CONFIGURATION = 0x20, 
        REMOTE_BUTTON = 0x21, 
        DISPLAY_PROTOCOL = 0x28, 
        TRAIN_CONTROL = 0x30, 
    };
 
    enum
    {
        MAX_SIZE = 72, 
    };
    
    enum Flag
    {
        FLAGS_NONE    = 0x00, 
        REPLY_PENDING = 0x80, 
        TIMEOUT_NONE  = 0x00, 
        TIMEOUT_2     = 0x01, 
        TIMEOUT_4     = 0x02, 
        TIMEOUT_8     = 0x03, 
        TIMEOUT_16    = 0x04, 
        TIMEOUT_32    = 0x05, 
        TIMEOUT_64    = 0x06, 
        TIMEOUT_128   = 0x07, 
        TIMEOUT_256   = 0x08, 
        TIMEOUT_512   = 0x09, 
        TIMEOUT_1024  = 0x0A, 
        TIMEOUT_2048  = 0x0B, 
        TIMEOUT_4096  = 0x0C, 
        TIMEOUT_8192  = 0x0D, 
        TIMEOUT_16384 = 0x0E, 
        TIMEOUT_32768 = 0x0F, 
        TIMEOUT_MASK  = 0x0F, 
    };
    
    enum Error
    {
        RESEND_OK          = 0x2000, 
        TRANSPORT_ERROR    = 0x6000, 
        BUFFER_UNAVAILABLE = 0x2020, 
        OUT_OF_ORDER       = 0x2040, 
        PERMANENT_ERROR    = 0x1000, 
        SRC_NOT_PERMITTED  = 0x1020, 
        NOT_ACCEPTED       = 0x1040, 
        UNIMPLEMENTED      = 0x1080, 
        INVALID_ARGUMENTS  = 0x1010, 
    };
 
    static bool resend_ok(uint16_t error)
    {
        return error & RESEND_OK;
    }
 
    static bool transport_error(uint16_t error)
    {
        return error & TRANSPORT_ERROR;
    }
 
    static bool buffer_unavailable(uint16_t error)
    {
        return error & BUFFER_UNAVAILABLE;
    }
    
    static unsigned int protocol_size(uint64_t protocol)
    {
        return (((protocol & PROTOCOL_SIZE_MASK) == PROTOCOL_SIZE_6) ? 6 :
                ((protocol & PROTOCOL_SIZE_MASK) == PROTOCOL_SIZE_2) ? 2 : 1);
    }
 
private:
    enum
    {
        PROTOCOL_SIZE_2    = 0xE0, 
        PROTOCOL_SIZE_6    = 0xF0, 
        PROTOCOL_SIZE_MASK = 0xF0, 
    };
 
    DatagramDefs();
};
 
 
}  // namespace openlcb
 
 
#endif // _OPENLCB_DATAGRAMDEFS_HXX_