DebugHandler.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  DebugHandler.qm Copyright 2013 - 2023 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.
*/
 
// this module requires Qore 1.19 or better
 
 
// require type definitions everywhere
// enable all warnings
 
 
namespace DebugHandler {
 
class WebSocketDebugConnection : public WebSocketHandler::WebSocketConnection {
 
public:
            hash cx;
protected:
            AbstractWebSocketDebugHandler dhandler;
 
public:
 
 
        constructor(AbstractWebSocketDebugHandler n_handler, hash n_cx);
 
 
 
        gotMessage(string msg);
 
 
 
        connectionClosed();
 
 
 
        registered();
 
    };
 
 
class AbstractWebSocketDebugHandler : public WebSocketHandler::WebSocketHandler {
 
public:
            WebSocketDebugProgramControl debugProgram;
            // default socket send timeout
            //const DefaultSocketSendTimeout = 30s;
            DebugLogger logger;
        constructor(WebSocketDebugProgramControl dpc, *HttpServer::AbstractAuthenticator auth, *hash opts) ;
 
 
        log(int verbosity, string fmt, ...);
 
 
        log2(int verbosity, string fmt, *list<auto> args);
 
 
        WebSocketHandler::WebSocketConnection getConnectionImpl(hash cx, hash hdr, string cid);
 
 
        abstract  *string getContentType();
        abstract string encodeData(auto data);
 
 
        abstract  receiveData(hash cx, string msg);
 
         sendData(hash cx, auto data);
 
 
         broadcastData(auto data);
 
 
        hash handleRequest(hash cx, hash hdr, *data b);
 
 
        logInfo(string fmt, ...);
 
 
        logDebug(string fmt, ...);
 
 
        logError(string fmt, ...);
 
    };
 
class WebSocketDebugHandler : public AbstractWebSocketDebugHandler {
 
public:
 
        constructor(WebSocketDebugProgramControl dpc, *HttpServer::AbstractAuthenticator auth, *hash opts) ;
 
 
         *string getContentType();
 
        string encodeData(auto data);
 
 
         receiveData(hash cx, string msg);
 
    };
 
 
class WebSocketDebugProgramControl : public DebugProgramControl {
 
public:
protected:
            list<AbstractWebSocketDebugHandler> handlers = ();
 
public:
 
 
        constructor(string serverName) ;
 
 
         sendDataImpl(hash cx, auto data);
 
         broadcastDataImpl(auto data);
 
         addHandler(AbstractWebSocketDebugHandler newHandler);
    };
};