ServerSentEventHandler.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  ServerSentEventHandler.qc Copyright 2025 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.
*/

namespace ServerSentEventHandler {

class ServerSentEventHandler : public HttpServer::AbstractHttpSocketHandler, public Logger::LoggerWrapper {
 
public:
        const DefaultSocketSendTimeout = 30s;

        const DefaultHeartbeatInterval = 20;

        const DefaultHeartbeatMsg = ":hb\n\n";

        const Options = ...;
 

        const SseResponseHeader = ...;
 

        const DataSerializationSupport = ...;
 
 
protected:
        RWLock rwl();

        string serialization;

        code serializer;

        hash<string, ServerSentEventConnection> ch;

        int heartbeat = DefaultHeartbeatInterval;

        string heartbeat_msg = DefaultHeartbeatMsg;
 
public:
 
private:
        string tlk = get_random_string(50);
 
public:


    constructor(*HttpServer::AbstractAuthenticator auth, *hash<auto> opts) ;
 

    constructor(hash<auto> opts) ;
 


    int getHeartbeat(ServerSentEventConnection conn);
 


    setHeartbeat(softint seconds);
 


    setHeartbeat(date seconds);
 


    hash<HttpResponseInfo> 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(ServerSentEventConnection conn, Socket sock);
 

    string encodeMessage(hash<SseMessageInfo> msg);
 

      static string serializeJson(auto v);

      static string serializeDefault(auto v);

    ServerSentEventConnection getConnectionImpl(Socket sock, hash<auto> cx, hash<auto> hdr, string cid);
 

    ServerSentEventConnection doNewConnection(Socket sock, hash<auto> cx, hash<auto> hdr, string cid);
 

    connectionRegisteredImpl(ServerSentEventConnection conn);
 

    deregisterConnectionImpl(ServerSentEventConnection conn);
 


    sendAll(hash<SseMessageInfo> msg);
 


    sendOne(softstring id, hash<SseMessageInfo> msg);
 

    stopOne(softstring id);
 

    logInfo(string fmt, ...);
 

    logError(string fmt, ...);
 

    logWarn(string fmt, ...);
 

    logDebug(string fmt, ...);
 

protected:
     string getHeartbeatMessage(ServerSentEventConnection conn);
public:
 

protected:
     registerNewConnectionIntern(string cid, ServerSentEventConnection conn);
public:
 

protected:
     removeConnectionLocked(string cid);
public:
 

protected:
     sendHeartbeatMsg(ServerSentEventConnection conn, Socket sock);
public:
 

protected:
     replayEventsSince(ServerSentEventConnection conn, auto id);
public:
 

protected:
     constructorInit(*hash<auto> opts);
public:
 
 
private:
     bool flushIoIntern(ServerSentEventConnection conn, Socket sock, bool update_tld);
public:
 
};
};