StreamDefs.hxx

Go to the documentation of this file.

 
#ifndef _OPENLCB_STREAMDEFS_HXX_
#define _OPENLCB_STREAMDEFS_HXX_
 
#include "openlcb/Defs.hxx"
 
namespace openlcb
{
 
struct StreamDefs
{
    static constexpr uint16_t MAX_PAYLOAD = 0xffff;
    static constexpr uint8_t INVALID_STREAM_ID = 0xff;
    static constexpr uint32_t INVALID_TOTAL_BYTE_COUNT = 0xffffffff;
 
    enum Flags
    {
        FLAG_CARRIES_ID = 0x01,
        FLAG_REJECT_OUT_OF_ORDER = 0x02,
        FLAG_PERMANENT_ERROR = 0x10,
        FLAG_TEMPORARY_ERROR = 0x20,
        FLAG_ACCEPT = 0x80,
    };
 
    enum AdditionalFlags
    {
        REJECT_INFO_LOGGED = 0x01,
        REJECT_PERMANENT_INVALID_REQUEST = 0x20,
        REJECT_PERMANENT_SRC_NOT_PERMITTED = 0x40,
        REJECT_PERMANENT_STREAMS_NOT_ACCEPTED = 0x80,
        REJECT_TEMPORARY_BUFFER_FULL = 0x20,
        REJECT_TEMPORARY_OUT_OF_ORDER = 0x40,
    };
 
    static constexpr uint16_t STREAM_ACCEPT = ((uint16_t)FLAG_ACCEPT) << 8;
 
    static constexpr uint16_t STREAM_ERROR_INVALID_ARGS =
        (((uint16_t)FLAG_PERMANENT_ERROR) << 8) |
        REJECT_PERMANENT_INVALID_REQUEST;
 
    static Payload create_initiate_request(uint16_t max_buffer_size,
        bool has_ident, uint8_t src_stream_id,
        uint8_t dst_stream_id = INVALID_STREAM_ID)
    {
        Payload p(6, 0);
        p[0] = max_buffer_size >> 8;
        p[1] = max_buffer_size & 0xff;
        p[2] = has_ident ? FLAG_CARRIES_ID : 0;
        p[3] = 0; // flags
        p[4] = src_stream_id;
        p[5] = dst_stream_id;
        return p;
    }
 
    static Payload create_initiate_response(uint16_t max_buffer_size,
        uint8_t src_stream_id, uint8_t dst_stream_id,
        uint16_t error_code = STREAM_ACCEPT)
    {
        Payload p(6, 0);
        p[0] = max_buffer_size >> 8;
        p[1] = max_buffer_size & 0xff;
        p[2] = error_code >> 8;
        p[3] = error_code & 0xff;
        p[4] = src_stream_id;
        p[5] = dst_stream_id;
        return p;
    }
 
    static Payload create_data_proceed(
        uint8_t src_stream_id, uint8_t dst_stream_id)
    {
        Payload p(2, 0);
        p[0] = src_stream_id;
        p[1] = dst_stream_id;
        return p;
    }
 
    static Payload create_close_request(uint8_t src_stream_id,
        uint8_t dst_stream_id, uint32_t total_bytes = INVALID_TOTAL_BYTE_COUNT)
    {
        Payload p(total_bytes != INVALID_TOTAL_BYTE_COUNT ? 6 : 2, 0);
        p[0] = src_stream_id;
        p[1] = dst_stream_id;
        if (total_bytes != INVALID_TOTAL_BYTE_COUNT)
        {
            p[2] = (total_bytes >> 24) & 0xff;
            p[3] = (total_bytes >> 16) & 0xff;
            p[4] = (total_bytes >> 8) & 0xff;
            p[5] = (total_bytes >> 0) & 0xff;
        }
        return p;
    }
};
 
} // namespace openlcb
 
#endif // _OPENLCB_STREAMDEFS_HXX_