NDEVRCommunicationLogic.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2020, 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: NDEVRFileServer
File: NDEVRCommunicationLogic
Included in API: True
Author(s): tyler.parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Dictionary.h>
#include <NDEVR/String.h>
#include <NDEVR/PasswordString.h>
#include "NDEVRDataPacket.h"
#include <NDEVR/LogPtr.h>
namespace NDEVR
{
    struct NDEVRConnectionData
    {
        NDEVRConnectionData()
        {
            rx_message.setupPacketHeader(false);
        }
        String connection_id;               
        void* socket = nullptr;             
        NDEVRDataPacket tx_message;         
        NDEVRDataPacket rx_message;         
        uint04 window_size = 1024U;         
    };

    struct NDEVRServerInfo
    {
        String address;                     
        uint02 port = Constant<uint02>::Invalid; 
        String username;                    
        PasswordString password;            
        bool secure = true;                 
    };

    class PacketListener
    {
    public:
        virtual void onReceive(NDEVRConnectionData& state) = 0;
        virtual void onConnectionChanged(void* socket, bool is_connected) = 0;
    };

    class NDEVRSERVERCLIENT_API NDEVRCommunicationLogic
    {
    public:
        NDEVRCommunicationLogic();
        virtual ~NDEVRCommunicationLogic() {};
        void addConnection(void* socket, const StringView& id);
        void removeConnection(void* socket);
        virtual void updateWindowSize(NDEVRConnectionData& state);
        bool sendAndReceiveData(NDEVRConnectionData& state);
        void addListener(PacketListener* listener);
        void changeConnectionState(void* socket, bool is_connected);
        void removeListener(PacketListener* listener) { m_listeners.removeElement(listener); }
        virtual void* connectTo(const NDEVRServerInfo& info) = 0;
        virtual void disconnectFrom(void* socket) = 0;
        bool readRxData(NDEVRConnectionData& state);
        virtual void sendMessage(void* target, NDEVRDataPacket&& data);
        const NDEVRConnectionData* connectionData(void* target);
        virtual void wait(const TimeSpan& span, LogPtr log = nullptr) = 0;
        const NDEVRServerInfo& connectionInfo() const { return m_connection_info; }
        virtual bool isOpen(void* socket = nullptr) const = 0;
    protected:
        virtual uint08 rx(void* socket, NDEVRDataPacket& packet) = 0;
        virtual uint08 tx(void* socket, NDEVRDataPacket& packet, uint08 max_size) = 0;
        virtual uint08 bytesAvailable(void* socket) = 0;
    protected:
        Buffer<PacketListener*> m_listeners;                    
        Dictionary<void*, NDEVRConnectionData*> m_connections;  
        NDEVRServerInfo m_connection_info;                      
    };
}