WebSocketHandler.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  WebSocketHandler.qm Copyright 2013 - 2024 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    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.
*/
 
// minimum Qore version
 
// require type definitions everywhere
 
// enable all warnings
 
 
 
 
namespace WebSocketHandler {
const WSC_Process = 0;
 
const WSC_Continue = 1;
 
const WSC_Break = 2;
 
 
class WebSocketConnection {
 
public:
        WebSocketHandler handler;
 
        bool stop_flag = False;
 
        // wait a maximum of 1/4 second for data
        const DefaultQueuePollingInterval = 250ms;
 
protected:
        Qore::Thread::Queue queue();
 
        int tid = gettid();
 
public:
 
private:
        Socket sock;
 
public:
 
 
    constructor(WebSocketHandler handler);
 
 
    setSocket(Socket sock);
 
 
 
    *binary pollData();
 
 
 
    *binary pollDataImmediate();
 
 
    sendEncoded(binary msg);
 
 
 
    send(data msg);
 
 
 
    send(data msg, int op, bool fin);
 
 
 
    gotMessage(string msg);
 
 
 
    gotMessage(binary msg);
 
 
 
    int gotRawMessage(hash<WsMsgInfo> msg);
 
 
 
    connectionClosed();
 
 
 
    registered();
 
 
 
    flush();
 
 
    stop();
 
};
 
 
class WebSocketHandler : public HttpServer::AbstractHttpSocketHandler, public Logger::LoggerWrapper {
 
public:
        const DefaultSocketSendTimeout = 30s;
 
        const DefaultHeartbeatInterval = 20s;
 
        const DefaultHeartbeatMsg = "heartbeat";
 
        const Options = ...;
 
 
protected:
        RWLock rwl();
 
        hash<string, WebSocketConnection> ch;
 
        softint heartbeat = DefaultHeartbeatInterval;
 
        string heartbeat_msg = DefaultHeartbeatMsg;
 
public:
 
private:
        string tlk = get_random_string(50);
 
public:
 
 
    constructor(*HttpServer::AbstractAuthenticator auth, *hash<auto> opts) ;
 
 
 
    int getHeartbeat();
 
 
 
    setHeartbeat(softint seconds);
 
 
 
    string getHeartbeatMessage();
 
 
 
    setHeartbeatMessage(string msg);
 
 
 
    hash<auto> handleRequest(hash<auto> cx, hash<auto> hdr, *data b);
 
 
 
    *list<string> getConnectionIds();
 
 
 
    bool startImpl(softstring lid, hash<auto> cx, hash<auto> hdr, Qore::Socket sock);
 
 
 
    bool flushIo(WebSocketConnection wsc, Socket sock);
 
 
private:
     bool flushIoIntern(WebSocketConnection wsc, Socket sock, bool update_tld);
public:
 
 
    WebSocketConnection getConnectionImpl(hash<auto> cx, hash<auto> hdr, string cid);
 
 
    WebSocketConnection doNewConnection(hash<auto> cx, hash<auto> hdr, string cid);
 
 
    deregisterConnectionImpl(WebSocketConnection wsc);
 
 
 
    sendAll(data d);
 
 
 
    sendOne(softstring id, data d);
 
 
    stopOne(softstring id);
 
 
protected:
     sendClose(Qore::Socket sock, int code, *string txtmsg);
public:
 
 
      static string getDataString(*data d);
 
    logInfo(string fmt, ...);
 
 
    logError(string fmt, ...);
 
 
    logWarn(string fmt, ...);
 
 
    logDebug(string fmt, ...);
 
};
};