HdlcdSessionDescriptor.h

Go to the documentation of this file.

#ifndef HDLCD_SESSION_DESCRIPTOR_H
#define HDLCD_SESSION_DESCRIPTOR_H

#include <stdint.h>

// Session types. Select only one!
typedef enum {
    SESSION_TYPE_TRX_ALL              = 0x00,
    SESSION_TYPE_TRX_STATUS           = 0x10,
    SESSION_TYPE_RX_PAYLOAD           = 0x20,
    SESSION_TYPE_RX_HDLC              = 0x30,
    SESSION_TYPE_RX_HDLC_DISSECTED    = 0x40,

    // Bookkeeping
    SESSION_TYPE_ARITHMETIC_ENDMARKER = 0x50,
    SESSION_TYPE_MASK                 = 0xF0,
    SESSION_TYPE_UNSET                = 0xFF
} E_SESSION_TYPE;

// Multiple combination of flags are possible
typedef enum {
    SESSION_FLAGS_NONE                = 0x00,
    SESSION_FLAGS_DELIVER_RCVD        = 0x01,
    SESSION_FLAGS_DELIVER_SENT        = 0x02,
    SESSION_FLAGS_DELIVER_INVALIDS    = 0x04,
    SESSION_FLAGS_RESERVED            = 0x08,
    
    // Bookkeeping
    SESSION_FLAGS_MASK                = 0x0F
} E_SESSION_FLAGS;

class HdlcdSessionDescriptor {
public:   
    // CTORs
    HdlcdSessionDescriptor(E_SESSION_TYPE a_eSessionType, uint8_t a_SessionFlags): m_ServiceAccessPointSpecifier(a_eSessionType | a_SessionFlags) {
        // Checks
        if (((a_eSessionType & SESSION_TYPE_MASK) >= SESSION_TYPE_ARITHMETIC_ENDMARKER) ||
            (a_eSessionType & ~SESSION_TYPE_MASK)) {
            // Invalid session type
            m_ServiceAccessPointSpecifier = SESSION_TYPE_UNSET;
        } // if
        
        if (a_SessionFlags & ~SESSION_FLAGS_MASK) {
            // Invalid flags
            m_ServiceAccessPointSpecifier = SESSION_TYPE_UNSET;
        } // if
    }
    
    explicit HdlcdSessionDescriptor(uint8_t a_ServiceAccessPointSpecifier): m_ServiceAccessPointSpecifier(a_ServiceAccessPointSpecifier) {
        // Checks
        if ((m_ServiceAccessPointSpecifier & SESSION_TYPE_MASK) >= SESSION_TYPE_ARITHMETIC_ENDMARKER) {
            // Invalid session type
            m_ServiceAccessPointSpecifier = SESSION_TYPE_UNSET;
        } // if
    }
    
    // Getter
    operator uint8_t() const {
        return m_ServiceAccessPointSpecifier;
    }
    
    E_SESSION_TYPE GetSessionType() const {
        return E_SESSION_TYPE(m_ServiceAccessPointSpecifier & SESSION_TYPE_MASK);
    }

    bool DeliversRcvdData() const {
        return (m_ServiceAccessPointSpecifier & SESSION_FLAGS_DELIVER_RCVD);
    }

    bool DeliversSentData() const {
        return (m_ServiceAccessPointSpecifier & SESSION_FLAGS_DELIVER_SENT);
    }

    bool DeliversInvalidData() const {
        return (m_ServiceAccessPointSpecifier & SESSION_FLAGS_DELIVER_INVALIDS);
    }

private:
    uint8_t m_ServiceAccessPointSpecifier;
};

#endif // HDLCD_SESSION_DESCRIPTOR_H