can_transport_protocol_base.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
 
#ifndef CAN_TRANSPORT_PROTOCOL_BASE_HPP
#define CAN_TRANSPORT_PROTOCOL_BASE_HPP
 
#include "isobus/isobus/can_control_function.hpp"
#include "isobus/isobus/can_message.hpp"
#include "isobus/isobus/can_message_data.hpp"
 
namespace isobus
{
    class TransportProtocolSessionBase
    {
    public:
        enum class Direction
        {
            Transmit, 
            Receive 
        };
 
        TransportProtocolSessionBase(TransportProtocolSessionBase::Direction direction,
                                     std::unique_ptr<CANMessageData> data,
                                     std::uint32_t parameterGroupNumber,
                                     std::uint32_t totalMessageSize,
                                     std::shared_ptr<ControlFunction> source,
                                     std::shared_ptr<ControlFunction> destination,
                                     TransmitCompleteCallback sessionCompleteCallback,
                                     void *parentPointer);
 
        TransportProtocolSessionBase(TransportProtocolSessionBase &&other) = default;
 
        TransportProtocolSessionBase &operator=(TransportProtocolSessionBase &&other) = default;
 
        virtual ~TransportProtocolSessionBase() = default;
 
        Direction get_direction() const;
 
        bool operator==(const TransportProtocolSessionBase &obj) const;
 
        bool matches(std::shared_ptr<ControlFunction> other_source, std::shared_ptr<ControlFunction> other_destination) const;
 
        CANMessageData &get_data() const;
 
        std::uint32_t get_message_length() const;
 
        virtual std::uint32_t get_total_bytes_transferred() const = 0;
 
        float get_percentage_bytes_transferred() const;
 
        std::shared_ptr<ControlFunction> get_source() const;
 
        std::shared_ptr<ControlFunction> get_destination() const;
 
        std::uint32_t get_parameter_group_number() const;
 
    protected:
        void update_timestamp();
 
        std::uint32_t get_time_since_last_update() const;
 
        void complete(bool success) const;
 
    private:
        Direction direction; 
        std::uint32_t parameterGroupNumber; 
        std::unique_ptr<CANMessageData> data; 
        std::shared_ptr<ControlFunction> source; 
        std::shared_ptr<ControlFunction> destination; 
        std::uint32_t timestamp_ms = 0; 
 
        std::uint32_t totalMessageSize; 
 
        TransmitCompleteCallback sessionCompleteCallback = nullptr; 
        void *parent = nullptr; 
    };
} // namespace isobus
 
#endif // CAN_TRANSPORT_PROTOCOL_BASE_HPP