portalwebsocketserver.h

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
#pragma once
 
// Local Includes
#include "portalevent.h"
 
// External Includes
#include <websocketserver.h>
#include <queue>
#include <mutex>
 
namespace nap
{
    // Forward Declares
    class PortalService;
 
    class NAPAPI PortalWebSocketServer : public IWebSocketServer
    {
        friend class PortalService;
        RTTI_ENABLE(IWebSocketServer)
    public:
        PortalWebSocketServer(PortalService& service);
 
        virtual bool init(utility::ErrorState& error) override;
 
        virtual void onDestroy() override;
 
        bool send(PortalEventPtr event, const WebSocketConnection& connection, utility::ErrorState& error);
 
        bool broadcast(PortalEventPtr event, utility::ErrorState& error);
 
        bool mSendWebSocketEvents = true;       
        bool mVerbose = true;                   
 
    private:
 
        // Called by web-socket server endpoint when a client connection opened
        virtual void onConnectionOpened(const WebSocketConnection& connection) override;
 
        // Called by web-socket server endpoint when a client connection closed
        virtual void onConnectionClosed(const WebSocketConnection& connection, int code, const std::string& reason) override;
 
        // Called by web-socket server endpoint when a client connection failed to extablish
        virtual void onConnectionFailed(const WebSocketConnection& connection, int code, const std::string& reason) override;
 
        // Called by web-socket server endpoint when a new message is received
        virtual void onMessageReceived(const WebSocketConnection& connection, const WebSocketMessage& message) override;
 
        void addPortalEvent(PortalEventPtr event);
 
        void consumePortalEvents(std::queue<PortalEventPtr>& outEvents);
 
        // Queue that holds all the received portal events
        std::queue<PortalEventPtr> mPortalEvents;
 
        // Mutex associated with setting / getting portal events
        std::mutex mPortalEventMutex;
 
        // Handle to the portal service
        PortalService* mService;
    };
 
    // Object creator used for constructing the portal WebSocket server
    using PortalWebSocketServerObjectCreator = rtti::ObjectCreator<PortalWebSocketServer, PortalService>;
}