SocketIO.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: SocketIO
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <QListWidget>
#include <QTimer>
#include <string>
#undef emit
#include <sio_client.h>
#include "DLLInfo.h"
#include "Base/Headers/String.h"
#include "Base/Headers/Dictionary.h"
#include "Base/Headers/Pointer.hpp"
#include "Base/Headers/UUID.h"
namespace NDEVR
{
    class SocketIOChannel;
    using namespace sio;
    /**--------------------------------------------------------------------------------------------------
    \brief Provides the ability to communicate over a network using SocketIO (https://socket.io/docs/v4/)
    **/
    class SOCKET_IO_API SocketIO : public QObject
    {
    protected:
        explicit SocketIO(QObject *parent = 0);
    public:
        ~SocketIO();
        static DynamicPointer<SocketIO> GetSocketIO(const String& url = "http://ndevr.org:3000");
        void setName(const String& name);
        void setRunID(const UUID& run_id);
        bool connect(const String& url = "http://ndevr.org:3000");
        void close();
        DynamicPointer<SocketIOChannel> createChannel(const String& name, UUID target = Constant<UUID>::Invalid);
        DynamicPointer<SocketIOChannel> createChannel(const String& name, std::function<void(const char* data, uint04 size)> data_callback, UUID target = Constant<UUID>::Invalid);
        void addChannel(DynamicPointer<SocketIOChannel>& channel);
        void removeChannel(DynamicPointer<SocketIOChannel>& channel);
        const Dictionary<UUID, String>& onlineClients() const;
        bool isConnected() const { return m_is_connected; }
        const String& url() const { return m_url; }
    private:
        void OnNewMessage(std::string const& name, message::ptr const& data, bool hasAck, message::list &ack_resp);
        void OnUserJoined(std::string const& name, message::ptr const& data, bool hasAck, message::list &ack_resp);
        void OnUserLeft(std::string const& name, message::ptr const& data, bool hasAck, message::list &ack_resp);
        void OnLogin(std::string const& name, message::ptr const& data, bool hasAck, message::list &ack_resp);
        void OnConnected(std::string const& nsp);
        void OnClosed(client::close_reason const& reason);
        void OnFailed();
        bool m_is_connected;
        std::unique_ptr<client> _io;
        Dictionary<UUID, String> m_online_users;
        String m_name;
        UUID m_run_id;
        String m_url = "ws://localhost:3000";
        Dictionary<String, DynamicPointer<SocketIOChannel>> m_socket_channels;
        static Dictionary<String, DynamicPointer<SocketIO>> s_server_channels;
 
    };
}