SocketIOChannel.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: SocketIOChannel
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "Base/Headers/String.h"
#include "Base/Headers/UUID.h"
 
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A specific channel of communication within the SocketIO framework.
    **/
    class SocketIOChannel
    {
        friend class SocketIO;
    protected:
        explicit SocketIOChannel(const String& name, UUID target = Constant<UUID>::Invalid)
            : m_recieve_data_callback(nullptr)
            , m_target(target)
            , m_name(name)
        {
            lib_assert(name.size() > 0 && !name.contains('|'), "Bad Socket channel name");
        }
        SocketIOChannel(const String& name, std::function<void(const char* data, uint04 size)> data_callback, UUID target = Constant<UUID>::Invalid)
            : m_recieve_data_callback(data_callback)
            , m_target(target)
            , m_name(name)
        {
            lib_assert(name.size() > 0 && !name.contains('|'), "Bad Socket channel name");
        }
    public:
        void setRecieveDataCallback(std::function<void(const char* data, uint04 size)> data_callback) { m_recieve_data_callback = data_callback; };
        void sendData(const char* data, uint04 size)
        {
            lib_assert(m_send_data_callback, "Tried to send without socket IO connection");
            if (m_send_data_callback)
                m_send_data_callback(data, size);
        };
        const String& name() const { return m_name; }
        const UUID& target() const { return m_target; }
    protected:
        void setSendDataCallback(std::function<void(const char* data, uint04 size)> data_callback) { m_send_data_callback = data_callback; };
        void recieveData(const char* data, uint04 size)
        {
            if (m_recieve_data_callback)
                m_recieve_data_callback(data, size);
        };
    protected:
        std::function<void(const char* data, uint04 size)> m_recieve_data_callback;
        std::function<void(const char* data, uint04 size)> m_send_data_callback;
        UUID m_target;
        String m_name;
    };
}