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 Methods
deprecated	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	DEPRECATED: creates the Ssh2ClientConnection object. More...
	constructor (string name, string description, string url, hash attributes={}, hash options={})
	creates the Ssh2ClientConnection object More...
string	getType ()
	returns "ssh2"
Public Member Methods inherited from Ssh2Connections::AbstractSsh2Connection
deprecated	constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
	DEPRECATED: creates the AbstractSsh2Connection object. More...
	constructor (string name, string description, string url, hash attributes={}, hash options={})
	creates the AbstractSsh2Connection object More...
hash	getOptions ()
	returns valid options More...

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

Private Member Methods
Qore::SSH2::SSH2Client	getImpl (bool connect=True, *hash rtopts)
	returns a Qore::SSH2::SSH2Client object More...
hash< ConnectionConstructorInfo >	getConstructorInfoImpl ()
	returns a hash that can be used to contruct the object dynamically 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() [1/2]

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

DEPRECATED: 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())

Deprecated:

since Qore 0.9

constructor() [2/2]

Ssh2Connections::Ssh2ClientConnection::constructor	(	string	name,
		string	description,
		string	url,
		hash	attributes = {},
		hash	options = {}
	)

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

private

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

Since

Ssh2Connections 1.1

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

make()

static deprecated SftpConnection Ssh2Connections::Ssh2ClientConnection::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