Ssh2Connections::Ssh2ClientConnection Class Reference

class for SSH2 client session connections; returns an object of class Qore::SSH2::SSH2Client More...

Inheritance diagram for Ssh2Connections::Ssh2ClientConnection:

Public Member Functions
	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	creates the Ssh2ClientConnection object More...
string	getType ()
	returns "ssh2"
Public Member Functions inherited from Ssh2Connections::AbstractSsh2Connection
	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	creates the SftpConnection object More...
hash	getOptions ()
	returns valid options More...

Static Public Member Functions
static SftpConnection	make (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	static constructor

Private Member Functions
Qore::SSH2::SSH2Client	getImpl (bool connect=True, *hash rtopts)
	returns a Qore::SSH2::SSH2Client object More...

Detailed Description

class for SSH2 client session connections; returns an object of class Qore::SSH2::SSH2Client

supports the following option:

• "keyfile": a path to a private key file in PEM format to use for key-based authentication (environment variables can be prefixed with "$" in the path (or optionally enclosed in curly brackets as in "${var}") and will be substituted with the value of the environment variable)

Member Function Documentation

constructor()

Ssh2Connections::Ssh2ClientConnection::constructor	(	string	name,
		string	desc,
		string	url,
		bool	monitor,
		*hash	opts,
		hash	urlh
	)

creates the Ssh2ClientConnection 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())

getImpl()

Qore::SSH2::SSH2Client Ssh2Connections::Ssh2ClientConnection::getImpl ( bool  connect = True, *hash  rtopts  )

private

returns a Qore::SSH2::SSH2Client object

Parameters

connect	if True, then Qore::SSH2::SSH2Client::connect() is called
rtopts	this connection type does not accept any runtime options, so this parameter is ignored

Returns

a Qore::SSH2::SSH2Client object