apiwebsocketevent.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
 
// External Includes
#include <apievent.h>
#include <websocketconnection.h>
#include <websocketinterface.h>
 
namespace nap
{
    /*
     * Adds web-socket functionality to a default nap::APIEvent. Use getConnection() 
     * to access the webs-socket connection handle to the client or server. Note 
     * that the handle could be invalid when a client or server disconnected or the connection
     * failed to establish. Use getInterface() to access the client or server associated with event. Most
     * likely the interface is a nap::APIWebSocketClient or nap::APIWebSocketServer.
     */
    class NAPAPI APIWebSocketEvent : public APIEvent
    {
        RTTI_ENABLE(APIEvent)
    public:
        APIWebSocketEvent(const std::string& name, const WebSocketConnection& connection, 
            WebSocketInterface& wsInterface);
 
        APIWebSocketEvent(std::string&& name, const WebSocketConnection& connection, 
            WebSocketInterface& wsInterface);
 
        APIWebSocketEvent(const std::string& name, const std::string& id, const WebSocketConnection& connection, 
            WebSocketInterface& wsInterface);
 
        APIWebSocketEvent(std::string&& name, std::string&& id, const WebSocketConnection& connection, 
            WebSocketInterface& wsInterface);
 
        const WebSocketConnection& getConnection() const            { return mConnection; }
 
        WebSocketInterface& getInterface();
 
        const WebSocketInterface& getInterface() const;
 
    private:
        WebSocketConnection mConnection;
        WebSocketInterface* mInterface = nullptr;
    };
 
    using APIWebSocketEventPtr = std::unique_ptr<APIWebSocketEvent>;
}