SocketConnection.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/Connection.h>
#include "Base/Headers/TranslatedString.h"
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A core ConnectionBackend for QAbstractSocket supporting TCP and UDP connections.
    **/
    class NDEVR_NETWORK_PROTOCOLS_API SocketConnection : public ConnectionBackend
    {
    public:
        SocketConnection(ProgressInfo* log);
        ~SocketConnection();
        virtual uint04 peek(char*, uint04 size) const final override;
        virtual uint04 rx(char*, uint04 size = Constant<uint04>::Max) final override;
        virtual void tx(const String& command) final override;
        virtual bool open(const ConnectionInfo& request) final override;
        virtual void close() final override;
        virtual bool isOpen() const final override;
        virtual uint04 bytesAvailable() const override;
        virtual TranslatedString lastError() const final override;
        virtual bool setTCPPort(QTcpSocket* tcp_port, ConnectionOpenType connect_mode);
        virtual bool setUDPPort(QUdpSocket* udp_port, ConnectionOpenType connect_mode);
        virtual bool waitForReadyRead(const TimeSpan& span) final override;
        virtual bool waitForConnection(QAbstractSocket* socket, const ConnectionInfo& request);
        void setSocket(QAbstractSocket* socket);
        bool openUDP(const ConnectionInfo& request);
        bool openUDPServer(const ConnectionInfo& request);
        bool openTCP(const ConnectionInfo& request);
    protected slots:
        void handleSocketErrorSlot(int error);
    protected:
        QAbstractSocket* m_socket = nullptr;
        TranslatedString m_last_error;
        uint02 m_broadcast_port = Constant<uint02>::Invalid;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionFactory that enables the creation of a SocketConnection for interfacing with
        a QAbstractSocket
    **/
    class SocketConnectionFactory : public ConnectionFactory
    {
    public:
        virtual bool handlesType(const String& request) const override;
        virtual ConnectionBackend* createConnection(const ConnectionInfo& request) override;
        virtual Buffer<ConnectionInfo> availableConnections(const ConnectionSearchParamaters& params) override;
        virtual Buffer<ConnectionCategory> availableConnectionCatagories() override;
    };
}