WebSocketConnection.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/Connection.h>
#include "Base/Headers/TranslatedString.h"
class QWebSocket;
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionBackend that allows the software to interface with QWebSocket for communicating
        with WebSocket devices.
 
    WebSockets is a web technology providing full-duplex communications channels over a single TCP connection. 
        The WebSocket protocol was standardized by the IETF as RFC 6455 in 2011. QWebSocket can both be used in a 
        client application and server application.
    **/
    class NDEVR_WEB_SOCKET_API WebSocketConnection : public ConnectionBackend
    {
        Q_OBJECT
    public:
        WebSocketConnection(ProgressInfo* log);
        ~WebSocketConnection();
        virtual uint04 peek(char*, uint04 size) const override;
        virtual uint04 rx(char*, uint04 size = Constant<uint04>::Max) override;
        virtual void tx(const String& command) override;
        virtual bool open(const ConnectionInfo& request) override;
        virtual void close() override;
        virtual bool isOpen() const override;
        virtual uint04 bytesAvailable() const override;
        virtual TranslatedString lastError() const override;
        virtual bool setPort(QWebSocket* tcp_port);
        virtual bool waitForReadyRead(const TimeSpan& span) override;
        virtual bool waitForConnection(QWebSocket* socket, const ConnectionInfo& request);
        void setSocket(QWebSocket* socket);
    protected slots:
        void handleSocketErrorSlot(int error);
        void binaryMessageRecieved(const QByteArray& array);
        void textMessageRecieved(const QString& message);
    protected:
        QWebSocket* m_socket = nullptr;
        TranslatedString m_last_error;
        String m_data;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionFactory that enables the creation of a WebSocketConnection for interfacing with
        a QWebSocket
    **/
    class WebSocketConnectionFactory : 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;
    };
}