75 namespace TelnetClient {
81 const DefaultTelnetPort = 23;
84 const DefaultConnTimeout = 15s;
90 const DefaultTerminalType =
"xterm";
93 const DefaultTerminalSpeed = 38400;
123 SE :
"SubnegotiationEnd",
127 IP :
"Interruptprocess",
130 EC :
"EraseCharacter",
133 SB :
"SubnegotiationBegin",
137 const SUPDUP_OPT = 21;
198 TOPT_APRX :
"ApproxMessageSizeNegotiation",
201 TOPT_REM :
"RemoteControlledTransandEcho",
204 TOPT_OCRD :
"OutputCarriage-ReturnDisposition",
205 TOPT_OHT :
"OutputHorizontalTabstops",
206 TOPT_OHTD :
"OutputHorizontalTabDisposition",
207 TOPT_OFD :
"OutputFormfeedDisposition",
208 TOPT_OVT :
"OutputVerticalTabstops",
209 TOPT_OVTD :
"OutputVerticalTabDisposition",
210 TOPT_OLD :
"OutputLinefeedDisposition",
222 TOPT_TLN :
"TerminalLocationNumber",
231 TOPT_AUTH :
"TelnetAuthenticationOption",
236 TOPT_RSP :
"TelnetRemoteSerialPort",
238 TOPT_SLE :
"TelnetSuppressLocalEcho",
329 connect(timeout timeout = DefaultConnTimeout);
504 nothing
setWarningQueue(
int warning_ms,
int warning_bs, Queue queue, any arg, timeout min_ms = 1s);
552 final disconnectIntern();
565 final sendDataIntern(softlist arr,
bool double_aic =
False);
571 sendTextDataIntern(
string str);
578 final *
string getAvailableDataIntern(timeout t = DefaultTimeout);
585 final updateWindowSizeIntern(
hash wh);
592 final processCmd(reference<string> rv);
599 final doSubNegotiation();
const TOPT_OCRD
OutputCarriage-ReturnDisposition.
Definition: TelnetClient.qm.dox.h:152
setUser(*string n_user)
sets or clears (in case passed with no value) the username parameter for logging in to the telnet ser...
const TOPT_OHTD
OutputHorizontalTabDisposition.
Definition: TelnetClient.qm.dox.h:154
clearStats()
Clears performance statistics.
const BRK
Break.
Definition: TelnetClient.qm.dox.h:107
constructor(string host, softint port, *code log, *code dbglog)
creates the TelnetClient object
const TOPT_SUPO
SUPDUPOutput.
Definition: TelnetClient.qm.dox.h:164
const GA
Go Ahead.
Definition: TelnetClient.qm.dox.h:113
*string getTerminalType()
this method provides the value that will be given as the terminal type in protocol negotiation ...
logDbg(string msg)
logs the message to the debug log closure set with the constructor (if any)
hash getEnvironment()
this method provides the value that will be given as the user's environment in protocol negotiation ...
bool isConnected()
returns True if the client is connected to the server
const TOPT_EXTOP
Extended-Options-List.
Definition: TelnetClient.qm.dox.h:190
const TOPT_APRX
ApproxMessageSizeNegotiation.
Definition: TelnetClient.qm.dox.h:146
*hash getRuntimeOptions()
returns runtime options
*string getUser()
returns the current value of the username parameter
const TOPT_NAWS
NegotiateAboutWindowSize.
Definition: TelnetClient.qm.dox.h:173
const TOPT_OVTD
OutputVerticalTabDisposition.
Definition: TelnetClient.qm.dox.h:157
const TOPT_TS
TerminalSpeed.
Definition: TelnetClient.qm.dox.h:174
const TOPT_SUP
SUPDUP.
Definition: TelnetClient.qm.dox.h:163
const TOPT_STAT
Status.
Definition: TelnetClient.qm.dox.h:147
string getTarget()
Returns the connection target string.
const TOPT_STARTTLS
TelnetStartTLS.
Definition: TelnetClient.qm.dox.h:187
const TOPT_SUPP
SuppressGoAhead.
Definition: TelnetClient.qm.dox.h:145
const TOPT_DATA
DataEntryTerminal.
Definition: TelnetClient.qm.dox.h:162
bool hasFeature(int fc)
returns True if the server has confirmed with a DO command that it supports the given feature ...
const TOPT_COMPORT
TelnetComPortControl.
Definition: TelnetClient.qm.dox.h:185
const WILL
WILL.
Definition: TelnetClient.qm.dox.h:103
const TOPT_X_AUTH
TelnetXAUTH.
Definition: TelnetClient.qm.dox.h:182
nothing clearWarningQueue()
Removes any warning Queue object from the Socket.
int getTerminalSpeed()
this method provides the value that will be given as the terminal speed in protocol negotiation ...
const EL
Erase Line.
Definition: TelnetClient.qm.dox.h:112
connect(timeout timeout=DefaultConnTimeout)
connects to the Telnet server
const TOPT_OM
OutputMarking.
Definition: TelnetClient.qm.dox.h:169
const TOPT_CHARSET
TelnetCHARSET.
Definition: TelnetClient.qm.dox.h:183
windowSizeUpdated()
this method should be called externally when the window size has changed
const DO
DO.
Definition: TelnetClient.qm.dox.h:101
const TOPT_SNDL
SendLocation.
Definition: TelnetClient.qm.dox.h:165
The TelnetClient class allows communication with a telnet server; it can be used directly or subclass...
Definition: TelnetClient.qm.dox.h:250
const TOPT_OFD
OutputFormfeedDisposition.
Definition: TelnetClient.qm.dox.h:155
const TOPT_OPS
OutputPageSize.
Definition: TelnetClient.qm.dox.h:151
const SB
Subnegotiation Begin.
Definition: TelnetClient.qm.dox.h:114
const TOPT_REM
RemoteControlledTransandEcho.
Definition: TelnetClient.qm.dox.h:149
const TOPT_BIN
BinaryTransmission.
Definition: TelnetClient.qm.dox.h:142
const TOPT_LOGO
Logout.
Definition: TelnetClient.qm.dox.h:160
const EC
Erase Character.
Definition: TelnetClient.qm.dox.h:111
const TOPT_OLW
OutputLineWidth.
Definition: TelnetClient.qm.dox.h:150
constructor(string name, string desc, string url, bool monitor, *hash opts, hash urlh)
creates the TelnetConnection object
hash getUsageInfo()
Returns performance statistics for the socket.
const AYT
Are You There.
Definition: TelnetClient.qm.dox.h:110
const TOPT_SEND_URL
Send-URL.
Definition: TelnetClient.qm.dox.h:189
const TOPT_TERM
TerminalType.
Definition: TelnetClient.qm.dox.h:166
string getType()
returns "telnet"
sendData(softlist arr)
sends data to the server
log(string msg)
logs the message to the log closure set with the constructor (if any)
const TOPT_ECHO
Echo|Is|Send.
Definition: TelnetClient.qm.dox.h:143
sendTextData(string str)
sends literal string data to the server; the text dat is converted to the socket's encoding if necess...
const TOPT_TACACS
TACACSUserIdent.
Definition: TelnetClient.qm.dox.h:168
*string getDisplay()
this method provides the value that will be given as the DISPLAY value in protocol negotiation ...
const TOPT_TLN
TerminalLocationNumber.
Definition: TelnetClient.qm.dox.h:170
destructor()
disconnects from the server if connected and deletes the object
const CmdMap
command name map
Definition: TelnetClient.qm.dox.h:117
const TOPT_XDL
XDisplayLocation.
Definition: TelnetClient.qm.dox.h:177
const TOPT_TN3270
TN3270Enhancements.
Definition: TelnetClient.qm.dox.h:181
disconnect()
disconnects from the Telnet server
const TOPT_LINE
Linemode.
Definition: TelnetClient.qm.dox.h:176
const TOPT_AUTH
TelnetAuthenticationOption.
Definition: TelnetClient.qm.dox.h:179
TelnetClient getImpl(bool connect=True, *hash rtopts)
returns an TelnetClient object
static TelnetConnection make(string name, string desc, string url, bool monitor, *hash opts, hash urlh)
static constructor
const IP
Interrupt process.
Definition: TelnetClient.qm.dox.h:108
const TOPT_EOR
EndofRecord.
Definition: TelnetClient.qm.dox.h:167
const TOPT_ENVIR
TelnetEnvironmentOption.
Definition: TelnetClient.qm.dox.h:178
const TOPT_BYTE
ByteMacro.
Definition: TelnetClient.qm.dox.h:161
const TOPT_ENVIR_NEW
TelnetNewEnvironmentOption.
Definition: TelnetClient.qm.dox.h:180
const TOPT_OLD
OutputLinefeedDisposition.
Definition: TelnetClient.qm.dox.h:158
nothing setWarningQueue(int warning_ms, int warning_bs, Queue queue, any arg, timeout min_ms=1s)
Sets a Queue object to receive socket warnings.
const AO
Abort output.
Definition: TelnetClient.qm.dox.h:109
const TOPT_OVT
OutputVerticalTabstops.
Definition: TelnetClient.qm.dox.h:156
const NOP
No Operation.
Definition: TelnetClient.qm.dox.h:105
const TOPT_X3
X.3PAD.
Definition: TelnetClient.qm.dox.h:172
const TOPT_OHT
OutputHorizontalTabstops.
Definition: TelnetClient.qm.dox.h:153
const IAC
IAC.
Definition: TelnetClient.qm.dox.h:99
const TOPT_RSP
TelnetRemoteSerialPort.
Definition: TelnetClient.qm.dox.h:184
class for Telnet connections; returns an object of class TelnetClient for connecting to telnet sessio...
Definition: TelnetClient.qm.dox.h:612
const TOPT_SLE
TelnetSuppressLocalEcho.
Definition: TelnetClient.qm.dox.h:186
const TOPT_RFC
RemoteFlowControl.
Definition: TelnetClient.qm.dox.h:175
const WONT
WONT.
Definition: TelnetClient.qm.dox.h:102
const DONT
DONT.
Definition: TelnetClient.qm.dox.h:100
const TOPT_RECN
Reconnection.
Definition: TelnetClient.qm.dox.h:144
hash getWindowSize()
this method provides the value that will be given as the terminal window size in protocol negotiation...
const SE
Subnegotiation End.
Definition: TelnetClient.qm.dox.h:104
const TOPT_KERMIT
TelnetKERMIT.
Definition: TelnetClient.qm.dox.h:188
const DM
Data Mark.
Definition: TelnetClient.qm.dox.h:106
const OptMap
option map, maps codes to text descriptions
Definition: TelnetClient.qm.dox.h:193
const TOPT_EXT
ExtendedASCII.
Definition: TelnetClient.qm.dox.h:159
const TOPT_3270
Telnet3270Regime.
Definition: TelnetClient.qm.dox.h:171
*string getAvailableData(timeout t=DefaultTimeout)
returns all data available as a string (which could be an empty string if no data is available in the...
const TOPT_TIM
TimingMark.
Definition: TelnetClient.qm.dox.h:148