PollingConnectionMonitor.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore PollingConnectionMonitor class definition
 
/*  PollingConnectionMonitor.qc Copyright 2016 - 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.
*/
 
 
namespace ConnectionProvider {
 
class PollingConnectionMonitor : public LoggerWrapper {
 
public:
    
 
protected:
        Mutex m();
 
        hash<string, hash<PollInfo>> cache;
 
        int tid;
 
        bool autostart = True;
 
        date ping_timeout = DefaultPingTimeout;
 
        date ping_repeat = DefaultPingRepeat;
 
        const IO_ADD = "add";
 
        const IO_UPDATE = "update";
 
        const IO_REMOVE = "remove";
 
        const IO_QUIT = "quit";
 
        const IO_QUIT_REMOVE_ALL = "quit-remove-all";
 
        const DefaultPingTimeout = 30s;
 
        const DefaultPingRepeat = 1m;
 
public:
 
private:
        File sem_write;
 
        ReadOnlyFile sem_read;
 
        hash<SocketPollInfo> sem_info;
 
        Counter mcnt();
 
        Queue cmdq();
 
public:
 
    constructor(*LoggerInterface logger) ;
 
 
    destructor();
 
 
    setAutostart(bool autostart = True);
 
 
    bool getAutostart();
 
 
 
    start();
 
 
    stop();
 
 
    stopClear();
 
 
    bool running();
 
 
 
    add(AbstractConnection conn, *hash<auto> other);
 
 
 
    addOrUpdate(AbstractConnection conn, *hash<auto> other);
 
 
 
    bool removeConnection(string name);
 
 
 
    removeConnectionEx(string name);
 
 
protected:
     startIntern();
public:
 
 
protected:
     int stopIntern();
public:
 
 
protected:
     ioThread();
public:
 
 
protected:
     handlePingSuccess(string name, date delta, *bool oldok);
public:
 
 
protected:
     handlePingFailed(string name, date delta, hash<ExceptionInfo> ex);
public:
 
 
protected:
     handlePingTimeout(string name, date delta);
public:
 
 
protected:
     handlePingTimeoutIntern(string name, date delta);
public:
 
 
protected:
     restartPing(string name, *bool force_restart);
public:
 
 
protected:
     *bool processCommands();
public:
 
 
protected:
     sendCmd(string cmd);
public:
 
};
};
 
// private symbols
namespace Priv {
hashdecl PollInfo {
    // poll start timestamp
    date start;
 
    # connection
    AbstractConnection conn;
 
    # poll operation
    AbstractPollOperation spop;
 
    # other data stored alongside the connection
    *hash<auto> other;
}
};