RadioTransport.h

/***************************************************************************
 * \file RadioTransport.h
 * \brief Defines an interface for transporting data to and from a radio.
 * \author DA
 * \author NH
 * \author MN
 * \copyright (c) 2017 CyberRadio Solutions, Inc.  All rights reserved.
 *
 ***************************************************************************/

#ifndef INCLUDED_LIBCYBERRADIO_DRIVER_RADIOTRANSPORT_H
#define INCLUDED_LIBCYBERRADIO_DRIVER_RADIOTRANSPORT_H

#include "LibCyberRadio/Common/BasicList.h"
#include "LibCyberRadio/Common/Debuggable.h"
#include "LibCyberRadio/Common/HttpsSession.h"
#include "LibCyberRadio/Common/SerialPort.h"
#include <string>


namespace LibCyberRadio
{
    namespace Driver
    {
        class RadioTransport : public Debuggable
        {
            public:
                RadioTransport(
                        bool json = false,
                        bool debug = false
                );
                virtual ~RadioTransport();
                RadioTransport(const RadioTransport& other);
                RadioTransport& operator=(const RadioTransport& other);
                virtual bool connect(
                        const std::string& mode,
                        const std::string& host_or_dev,
                        const int port_or_baudrate
                );
                virtual void disconnect();
                virtual bool isConnected() const;
                void setJson( bool json );
                virtual bool sendCommand(
                        const std::string& cmdString,
                        bool clearRx = true
                );
                virtual BasicStringList receive(
                        double timeout = -1
                );
                virtual std::string getLastCommandErrorInfo() const;

            protected:
                virtual bool connectTcp(
                        const std::string& host,
                        int port
                );
                virtual bool connectUdp(
                        const std::string& host,
                        int port
                );
                virtual bool connectHttps(
                        const std::string& host,
                        int port
                );
                virtual bool connectTty(
                        const std::string& dev,
                        int baudrate
                );
                virtual bool sendCommandTcp(
                        const std::string& cmdString,
                        bool clearRx = true
                );
                virtual bool sendCommandUdp(
                        const std::string& cmdString,
                        bool clearRx = true
                );
                virtual bool sendCommandHttps(
                        const std::string& cmdString,
                        bool clearRx = true
                );
                virtual bool sendCommandTty(
                        const std::string& cmdString,
                        bool clearRx = true
                );
                virtual BasicStringList receiveJson(
                        double timeout = -1
                );
                // receiveJsonTcp()
                // receiveJsonTty()
                // receiveJsonUdp()
                virtual BasicStringList receiveJsonHttps(
                        double timeout = -1
                );

                virtual BasicStringList receiveJsonUdp(
                        double timeout = -1
                );
                virtual BasicStringList receiveCli(
                        double timeout = -1
                );
                virtual BasicStringList receiveCliTcp(
                        double timeout = -1
                );
                virtual BasicStringList receiveCliUdp(
                        double timeout = -1
                );
                virtual BasicStringList receiveCliTty(
                        double timeout = -1
                );
                virtual void translateErrno();

            protected:
                // Is this transport using JSON?
                bool _isJson;
                // TCP socket descriptor
                int _tcpSocket;
                // UDP socket descriptor
                int _udpSocket;
                // TTY (serial) link object
                ::LibCyberRadio::SerialPort* _serial;
                // HTTPS session variables
                HttpsSession* _httpsSession;
                // -- Connection test and API command URLs
                std::string _httpsConnTestUrl;
                std::string _httpsApiCmdUrl;
                // Error message from the last command executed
                std::string _lastCmdErrInfo;

        };


    } /* namespace Driver */

} /* namespace LibCyberRadio */

#endif /* INCLUDED_LIBCYBERRADIO_DRIVER_RADIOTRANSPORT_H */