SocketIODriver.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Hardware
File: SocketIODriver
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <QIODevice>
#include <NDEVR/Connection.h>
#include "Base/Headers/Buffer.hpp"
#include "Base/Headers/Dictionary.h"
#include "Base/Headers/Pointer.hpp"
 
namespace NDEVR
{
    class TimeSpan;
    class SocketIOChannel;
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionBackend that allows the software to interface with SocketIO for communicating
        with across networks.
    **/
    class SOCKET_IO_API SocketIODriver : public ConnectionBackend
    {
    public:
        SocketIODriver(ProgressInfo* log = nullptr);
        SocketIODriver(DynamicPointer<SocketIOChannel> socket, ProgressInfo* log = nullptr);
        ~SocketIODriver() = default;
        SocketIODriver(const SocketIODriver& other) = delete;
        SocketIODriver(SocketIODriver&& other) = delete;
        SocketIODriver& operator=(const SocketIODriver& other) = delete;
        SocketIODriver& operator=(SocketIODriver&& other) = delete;
 
        virtual uint04 peek(char* s, uint04 size = Constant<uint04>::Max) const override;
        virtual uint04 rx(char* s, uint04 max_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 bool waitForReadyRead(const TimeSpan& span) override;
        virtual TranslatedString lastError() const override;
        virtual uint04 bytesAvailable() const override;
    private:
        DynamicPointer<SocketIOChannel> m_socket;
        QByteArray m_channel_write_buffer;
        QByteArray m_channel_read_buffer;
        Dictionary<int, unsigned int> m_received_bytes;
        std::mutex m_critical_section;//critical section for this object only
        bool m_is_open = false;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionFactory that enables the creation of a SocketIODriver for interfacing with
        a SocketIO
    **/
    class SocketIOConnectionFactory : 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;
    };
}