TelnetClient.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  TelnetClient.qm Copyright 2012 - 2023 Qore Technologies s.r.o.
 
    Original Author: Pavol Potancok
 
    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 required Qore version
 
// assume local var scope, do not use "$" for vars, members, and method calls
 
 
 
namespace TelnetClient {
// default telnet port
const DefaultTelnetPort = 23;
 
// default connection timeout
const DefaultConnTimeout = 15s;
 
// default poll timeout
const DefaultTimeout = 100ms;
 
// default terminal type
const DefaultTerminalType = "xterm";
 
// default terminal speed
const DefaultTerminalSpeed = 38400;
 
const IAC  = 255; #!< IAC
const DONT = 254; #!< DONT
const DO   = 253; #!< DO
const WONT = 252; #!< WONT
const WILL = 251; #!< WILL
const SE  = 240;  #!< Subnegotiation End
const NOP = 241;  #!< No Operation
const DM  = 242;  #!< Data Mark
const BRK = 243;  #!< Break
const IP  = 244;  #!< Interrupt process
const AO  = 245;  #!< Abort output
const AYT = 246;  #!< Are You There
const EC  = 247;  #!< Erase Character
const EL  = 248;  #!< Erase Line
const GA  = 249;  #!< Go Ahead
const SB =  250;  #!< Subnegotiation Begin
 
const CmdMap = ...;
 
 
const SUPDUP_OPT = 21; # SUPDUP_OPT display protocol
 
const TOPT_BIN = 0;         #!< BinaryTransmission
const TOPT_ECHO = 1;        #!< Echo|Is|Send
const TOPT_RECN = 2;        #!< Reconnection
const TOPT_SUPP = 3;        #!< SuppressGoAhead
const TOPT_APRX = 4;        #!< ApproxMessageSizeNegotiation
const TOPT_STAT = 5;        #!< Status
const TOPT_TIM = 6;         #!< TimingMark
const TOPT_REM = 7;         #!< RemoteControlledTransandEcho
const TOPT_OLW = 8;         #!< OutputLineWidth
const TOPT_OPS = 9;         #!< OutputPageSize
const TOPT_OCRD = 10;       #!< OutputCarriage-ReturnDisposition
const TOPT_OHT = 11;        #!< OutputHorizontalTabstops
const TOPT_OHTD = 12;       #!< OutputHorizontalTabDisposition
const TOPT_OFD = 13;        #!< OutputFormfeedDisposition
const TOPT_OVT = 14;        #!< OutputVerticalTabstops
const TOPT_OVTD = 15;       #!< OutputVerticalTabDisposition
const TOPT_OLD = 16;        #!< OutputLinefeedDisposition
const TOPT_EXT = 17;        #!< ExtendedASCII
const TOPT_LOGO = 18;       #!< Logout
const TOPT_BYTE = 19;       #!< ByteMacro
const TOPT_DATA = 20;       #!< DataEntryTerminal
const TOPT_SUP = 21;        #!< SUPDUP
const TOPT_SUPO = 22;       #!< SUPDUPOutput
const TOPT_SNDL = 23;       #!< SendLocation
const TOPT_TERM = 24;       #!< TerminalType
const TOPT_EOR = 25;        #!< EndofRecord
const TOPT_TACACS = 26;     #!< TACACSUserIdent
const TOPT_OM = 27;         #!< OutputMarking
const TOPT_TLN = 28;        #!< TerminalLocationNumber
const TOPT_3270 = 29;       #!< Telnet3270Regime
const TOPT_X3 = 30;         #!< X.3PAD
const TOPT_NAWS = 31;       #!< NegotiateAboutWindowSize
const TOPT_TS = 32;         #!< TerminalSpeed
const TOPT_RFC = 33;        #!< RemoteFlowControl
const TOPT_LINE = 34;       #!< Linemode
const TOPT_XDL = 35;        #!< XDisplayLocation
const TOPT_ENVIR = 36;      #!< TelnetEnvironmentOption
const TOPT_AUTH = 37;       #!< TelnetAuthenticationOption
const TOPT_ENVIR_NEW = 39;  #!< TelnetNewEnvironmentOption
const TOPT_TN3270 = 40;     #!< TN3270Enhancements
const TOPT_X_AUTH = 41;     #!< TelnetXAUTH
const TOPT_CHARSET = 42;    #!< TelnetCHARSET
const TOPT_RSP = 43;        #!< TelnetRemoteSerialPort
const TOPT_COMPORT = 44;    #!< TelnetComPortControl
const TOPT_SLE = 45;        #!< TelnetSuppressLocalEcho
const TOPT_STARTTLS = 46;   #!< TelnetStartTLS
const TOPT_KERMIT = 47;     #!< TelnetKERMIT
const TOPT_SEND_URL = 48;   #!< Send-URL
const TOPT_EXTOP = 255;     #!< Extended-Options-List
 
const OptMap = ...;
 
 
 
class TelnetClient {
 
public:
protected:
        // the connection string
        string connect;
 
        // the socket for all communication with the server
        Socket conn();
 
        // to manage contention on the Socket
        Mutex m();
 
        // login user
        *string user;
 
        // logging closures
        *code log_info;
        *code log_debug;
 
        // hash of features the telnet server has asked for
        hash fh;
 
public:
 
    // no public members
    
 
 
    constructor(string host, softint port, *code log, *code dbglog);
 
 
 
    constructor(string connect, *code log, *code dbglog);
 
 
    destructor();
 
 
protected:
     log(string msg);
public:
 
 
protected:
     logDbg(string msg);
public:
 
 
 
    connect(timeout timeout = DefaultConnTimeout);
 
 
    bool isConnected();
 
 
 
    setUser(*string n_user);
 
 
    *string getUser();
 
 
 
    disconnect();
 
 
 
    sendData(softlist arr);
 
 
 
    sendTextData(string str);
 
 
 
    *string getAvailableData(timeout t = DefaultTimeout);
 
 
 
    bool hasFeature(int fc);
 
 
 
    windowSizeUpdated();
 
 
 
protected:
     *string getDisplay();
public:
 
 
 
protected:
     *string getTerminalType();
public:
 
 
 
protected:
     hash getEnvironment();
public:
 
 
 
protected:
     int getTerminalSpeed();
public:
 
 
 
protected:
     hash getWindowSize();
public:
 
 
 
    nothing clearWarningQueue();
 
 
 
    nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, any arg, timeout min_ms = 1s);
 
 
 
    hash<auto> getUsageInfo();
 
 
 
    clearStats();
 
 
 
    setEventQueue(Qore::Thread::Queue queue, auto arg, *bool with_data);
 
 
 
    setEventQueue();
 
 
 
    string getTarget();
 
 
    // don't override this method, fix/enhance it with a patch to the module
protected:
     final disconnectIntern();
public:
 
 
protected:
     checkConnIntern();
public:
 
 
    // don't override this method, fix/enhance it with a patch to the module
protected:
     final sendDataIntern(softlist arr, bool double_aic = False);
public:
 
 
protected:
     sendTextDataIntern(string str);
public:
 
 
    // don't override this method, fix/enhance it with a patch to the module
protected:
     final *string getAvailableDataIntern(timeout t = DefaultTimeout);
public:
 
 
    // don't override this method, fix/enhance it with a patch to the module
protected:
     final updateWindowSizeIntern(hash wh);
public:
 
 
    // don't override this method, fix/enhance it with a patch to the module
protected:
     final processCmd(reference<string> rv);
public:
 
 
    // don't override this method, fix/enhance it with a patch to the module
protected:
     final doSubNegotiation();
public:
 
};
 
 
class TelnetConnection : public ConnectionProvider::AbstractConnectionWithInfo {
 
public:
        const ConnectionScheme = <ConnectionSchemeInfo>{
            "cls": Class::forName("TelnetConnection"),
        };
 
 
    constructor(string name, string description, string url, hash attributes = {}, hash options = {})
 ;
 
 
    string getType();
 
 
 
    *hash<auto> getRuntimeOptions();
 
 
 
protected:
     TelnetClient getImpl(bool connect = True, *hash rtopts);
public:
 
 
protected:
     hash<ConnectionSchemeInfo> getConnectionSchemeInfoImpl();
public:
 
};
};