ProtocolState.h

Go to the documentation of this file.

#ifndef PROTOCOL_STATE_H
#define PROTOCOL_STATE_H

#include <vector>
#include <boost/asio.hpp>
#include <memory>
#include <deque>
#include "AliveState.h"
#include "HdlcFrame.h"
#include "FrameParser.h"
class ISerialPortHandler;

class ProtocolState: public std::enable_shared_from_this<ProtocolState> {
public:
    ProtocolState(std::shared_ptr<ISerialPortHandler> a_SerialPortHandler, boost::asio::io_service& a_IOService);
    
    void Start();
    void Stop();
    void Shutdown();

    void SendPayload(const std::vector<unsigned char> &a_Payload, bool a_bReliable);
    void TriggerNextHDLCFrame();
    void AddReceivedRawBytes(const unsigned char* a_Buffer, size_t a_Bytes);
    void InterpretDeserializedFrame(const std::vector<unsigned char> &a_Payload, const HdlcFrame& a_HdlcFrame, bool a_bMessageInvalid);
    
    // Query state
    bool IsAlive() const { return m_AliveState->IsAlive(); }
    bool IsRunning() const  { return m_bStarted; }

private:
    // Internal helpers
    void Reset();
    void OpportunityForTransmission();
    HdlcFrame PrepareIFrame();
    HdlcFrame PrepareSFrameRR();
    HdlcFrame PrepareSFrameSREJ();
    HdlcFrame PrepareUFrameUI();
    HdlcFrame PrepareUFrameTEST();
    
    // Members
    bool m_bStarted;
    bool m_bAwaitsNextHDLCFrame;
    unsigned char m_SSeqOutgoing; // The sequence number we are going to use for the transmission of the next packet
    unsigned char m_RSeqIncoming; // The start of the RX window we offer our peer, defines which packets we expect
    
    // State of pending actions
    bool m_bSendProbe;
    bool m_bPeerStoppedFlow;        // RNR condition
    bool m_bPeerStoppedFlowNew;     // RNR condition
    bool m_bPeerStoppedFlowQueried; // RNR condition
    bool m_bPeerRequiresAck;
    bool m_bWaitForAck;
    std::deque<unsigned char> m_SREJs;
    
    // Parser and generator
    std::shared_ptr<ISerialPortHandler> m_SerialPortHandler;
    FrameParser m_FrameParser;
    
    // Wait queues
    std::deque<std::vector<unsigned char>> m_WaitQueueReliable;
    std::deque<std::vector<unsigned char>> m_WaitQueueUnreliable;
    
    // Alive state
    std::shared_ptr<AliveState> m_AliveState;
    
    // Timer
    boost::asio::deadline_timer m_Timer;
    bool m_bAliveReceivedSometing;
};

#endif // PROTOCOL_STATE_H