TelnetClient::TelnetConnection Class Reference

class for Telnet connections; returns an object of class TelnetClient for connecting to telnet sessions More...

Inheritance diagram for TelnetClient::TelnetConnection:

Public Member Methods
deprecated	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	DEPRECATED: creates the TelnetConnection object. More...
	constructor (string name, string description, string url, hash attributes={}, hash options={})
	creates the RestConnection connection object More...
*hash	getRuntimeOptions ()
	returns runtime options More...
string	getType ()
	returns "telnet"

Static Public Member Methods
static deprecated TelnetConnection	make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	DEPRECATED: static constructor. More...

Private Member Methods
hash< ConnectionConstructorInfo >	getConstructorInfoImpl ()
	returns a hash that can be used to construct the object dynamically More...
TelnetClient	getImpl (bool connect=True, *hash rtopts)
	returns an TelnetClient object More...

Detailed Description

class for Telnet connections; returns an object of class TelnetClient for connecting to telnet sessions

supports the following runtime options in getImpl() for connection logging:

• "log": a closure accepting a single string for logging
• "dbglog": a closure taking a single string for detailed technical connection logging

Since

TelnetClient 1.3

Member Function Documentation

constructor() [1/2]

deprecated TelnetClient::TelnetConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash	opts,
		hash	urlh
	)

DEPRECATED: creates the TelnetConnection object.

Parameters

name	the name of the connection
desc	connection description
url	connection URL
monitor	monitoring flag
opts	connection options
urlh	broken down URL hash (as returned by Qore::parse_url())

Deprecated:

since Qore 0.9

constructor() [2/2]

TelnetClient::TelnetConnection::constructor	(	string	name,
		string	description,
		string	url,
		hash	attributes = {},
		hash	options = {}
	)

creates the RestConnection connection object

Parameters

name	the name of the connection
description	connection description
url	connection URL (potentially with password info)
attributes	various attributes. See below
options	connection options

See AbstractConnection::constructor() for attributes and options reference.

getConstructorInfoImpl()

hash<ConnectionConstructorInfo> TelnetClient::TelnetConnection::getConstructorInfoImpl ( )

privatevirtual

returns a hash that can be used to construct the object dynamically

Since

TelnetClient 1.4

Implements ConnectionProvider::AbstractConnection.

getImpl()

TelnetClient TelnetClient::TelnetConnection::getImpl ( bool  connect = True, *hash  rtopts  )

privatevirtual

returns an TelnetClient object

Parameters

connect	if True, then TelnetClient::connect() is called
rtopts	supports the following runtime options in getImpl() for connection logging: "log": a closure accepting a single string for logging "dbglog": a closure taking a single string for detailed technical connection logging

Returns

an TelnetClient object

Implements ConnectionProvider::AbstractConnection.

getRuntimeOptions()

*hash TelnetClient::TelnetConnection::getRuntimeOptions

(

)

returns runtime options

Returns

a hash with the following keys reflecting support for the corresponding runtime options in getImpl() for connection logging:

• "log": a closure accepting a single string for logging
• "dbglog": a closure taking a single string for detailed technical connection logging

make()

static deprecated TelnetConnection TelnetClient::TelnetConnection::make ( string  name, string  desc, string  url, bool  monitor, *hash  opts, hash  urlh  )

static

DEPRECATED: static constructor.

Deprecated:

since Qore 0.9 in favor of new constructor and Qore::Reflection