Qore TelnetClient Module Reference
1.0
|
The TelnetClient class allows communication with a telnet server; it can be used directly or subclassed with overridden methods to customize its behavior. More...
Public Member Functions | |
clearStats () | |
Clears performance statistics. More... | |
nothing | clearWarningQueue () |
Removes any warning Queue object from the Socket. More... | |
connect (timeout timeout=DefaultConnTimeout) | |
connects to the Telnet server More... | |
constructor (string host, softint port, *code log, *code dbgLog) | |
creates the TelnetClient object More... | |
constructor (string connect, *code log, *code dbglog) | |
creates the TelnetClient object More... | |
destructor () | |
disconnects from the server if connected and deletes the object | |
disconnect () | |
disconnects from the Telnet server More... | |
*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 timeout period) or NOTHING if the connection was closed by the remote end More... | |
private *string | getDisplay () |
this method provides the value that will be given as the DISPLAY value in protocol negotiation More... | |
private hash | getEnvironment () |
this method provides the value that will be given as the user's environment in protocol negotiation More... | |
private int | getTerminalSpeed () |
this method provides the value that will be given as the terminal speed in protocol negotiation More... | |
private *string | getTerminalType () |
this method provides the value that will be given as the terminal type in protocol negotiation More... | |
hash | getUsageInfo () |
Returns performance statistics for the socket. More... | |
*string | getUser () |
returns the current value of the username parameter | |
private hash | getWindowSize () |
this method provides the value that will be given as the terminal window size in protocol negotiation More... | |
bool | hasFeature (int fc) |
returns True if the server has confirmed with a DO command that it supports the given feature More... | |
bool | isConnected () |
returns True if the client is connected to the server | |
private | log (string msg) |
logs the message to the log closure set with the constructor (if any) | |
private | logDbg (string msg) |
logs the message to the debug log closure set with the constructor (if any) | |
sendData (softlist arr) | |
sends data to the server More... | |
sendTextData (string str) | |
sends literal string data to the server; the text dat is converted to the socket's encoding if necessary More... | |
setUser (*string user) | |
sets or clears (in case passed with no value) the username parameter for logging in to the telnet server More... | |
nothing | setWarningQueue (int warning_ms, int warning_bs, Queue queue, any arg, timeout min_ms=1s) |
Sets a Queue object to receive socket warnings. More... | |
windowSizeUpdated () | |
this method should be called externally when the window size has changed More... | |
The TelnetClient class allows communication with a telnet server; it can be used directly or subclassed with overridden methods to customize its behavior.
This class uses a Mutex lock in each TelnetClient object to ensure thread serialization to the underlying socket and its internal configuration, so it is safe to access in a multithreaded context.
TelnetClient::TelnetClient::clearStats | ( | ) |
Clears performance statistics.
nothing TelnetClient::TelnetClient::clearWarningQueue | ( | ) |
Removes any warning Queue object from the Socket.
TelnetClient::TelnetClient::connect | ( | timeout | timeout = DefaultConnTimeout | ) |
connects to the Telnet server
If the object is already connected, it is disconnected and a new connection attempt is made.
TelnetClient::TelnetClient::constructor | ( | string | host, |
softint | port, | ||
*code | log, | ||
*code | dbgLog | ||
) |
creates the TelnetClient object
host | the hostname of the telnet server (use [hostname] to explicitly specify an ipv6 connection) |
port | the port number of the telnet server |
log | a closure or call reference for log messages; a single string argument will be passed to this code for logging |
dbgLog | a closure for debugging/technical log messages; a single string argument will be passed to this code for logging |
TelnetClient::TelnetClient::constructor | ( | string | connect, |
*code | log, | ||
*code | dbglog | ||
) |
creates the TelnetClient object
connect | the hostname of the Telnet server or a hostname:port specification (use [hostname] or [address] for ipv6 connections) |
log | a closure or call reference for log messages; a single string argument will be passed to this code for logging |
dbglog | a closure for debugging/technical log messages; a single string argument will be passed to this code for logging |
TelnetClient::TelnetClient::disconnect | ( | ) |
disconnects from the Telnet server
*string TelnetClient::TelnetClient::getAvailableData | ( | timeout | t = DefaultTimeout | ) |
returns all data available as a string (which could be an empty string if no data is available in the timeout period) or NOTHING if the connection was closed by the remote end
NOTHING is only returned if the remote end closed the connection
private *string TelnetClient::TelnetClient::getDisplay | ( | ) |
this method provides the value that will be given as the DISPLAY value in protocol negotiation
override this method in a subclass to provide a different value
private hash TelnetClient::TelnetClient::getEnvironment | ( | ) |
this method provides the value that will be given as the user's environment in protocol negotiation
override this method in a subclass to provide a different value
private int TelnetClient::TelnetClient::getTerminalSpeed | ( | ) |
this method provides the value that will be given as the terminal speed in protocol negotiation
override this method in a subclass to provide a different value
private *string TelnetClient::TelnetClient::getTerminalType | ( | ) |
this method provides the value that will be given as the terminal type in protocol negotiation
override this method in a subclass to provide a different value
hash TelnetClient::TelnetClient::getUsageInfo | ( | ) |
Returns performance statistics for the socket.
"bytes_sent"
: an integer giving the total amount of bytes sent"bytes_recv"
: an integer giving the total amount of bytes received"us_sent"
: an integer giving the total number of microseconds spent sending data"us_recv"
: an integer giving the total number of microseconds spent receiving data"arg"
: (only if warning values have been set with TelnetClient::setWarningQueue()) the optional argument for warning hashes"timeout"
: (only if warning values have been set with TelnetClient::setWarningQueue()) the warning timeout in microseconds"min_throughput"
: (only if warning values have been set with TelnetClient::setWarningQueue()) the minimum warning throughput in bytes/secprivate hash TelnetClient::TelnetClient::getWindowSize | ( | ) |
this method provides the value that will be given as the terminal window size in protocol negotiation
The default implementation of this method is to return the actual terminal size by calling TermIOS::getWindowSize(). Override this method in a subclass to provide a different value.
rows:
the number of rows in the displaycolumns:
the number of columns in the display bool TelnetClient::TelnetClient::hasFeature | ( | int | fc | ) |
returns True if the server has confirmed with a DO command that it supports the given feature
fc | The feature code to check; see Telnet Command Option Codes for possible values; supported features are: |
TelnetClient::TelnetClient::sendData | ( | softlist | arr | ) |
sends data to the server
arr | a single element or a list of elements to send to the server; elements can be as follows:
|
SEND-ERROR | this exception is thrown if an invalid data type is passed to this method |
NOT-CONNECTED-EXCEPTION | if the socket is not already connected then this exception is thrown |
TelnetClient::TelnetClient::sendTextData | ( | string | str | ) |
sends literal string data to the server; the text dat is converted to the socket's encoding if necessary
str | currently sent verbatim to the server; no encoding conversions are performed on this string (possibly these should be scanned for IAC characters which should be duplicated) |
NOT-CONNECTED-EXCEPTION | if the socket is not already connected then this exception is thrown |
TelnetClient::TelnetClient::setUser | ( | *string | user | ) |
sets or clears (in case passed with no value) the username parameter for logging in to the telnet server
nothing TelnetClient::TelnetClient::setWarningQueue | ( | int | warning_ms, |
int | warning_bs, | ||
Queue | queue, | ||
any | arg, | ||
timeout | min_ms = 1s |
||
) |
Sets a Queue object to receive socket warnings.
warning_ms | the threshold in milliseconds for individual socket actions (send, receive, connect), if exceeded, a socket warning is placed on the warning queue with the following keys:
|
warning_bs | value in bytes per second; if any call has performance below this threshold, a socket warning is placed on the warning queue with the following keys:
|
queue | the Queue object to receive warning events |
arg | an optional argument to be placed in the "arg" key in each warning hash (could be used to identify the socket for example) |
min_ms | the minimum transfer time with a resolution of milliseconds for a transfer to be eligible for triggering a warning; transfers that take less than this period of time are not eligible for raising a warning |
QUEUE-ERROR | the Queue passed has a maximum size set |
SOCKET-SETWARNINGQUEUE-ERROR | at least one of warning_ms and warning_bs must be > 0 |
TelnetClient::TelnetClient::windowSizeUpdated | ( | ) |
this method should be called externally when the window size has changed