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

Inheritance diagram for Ssh2Connections::Ssh2ClientConnection:

Public Member Methods
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the Ssh2ClientConnection object More...

string	getType ()
	returns `"ssh2"`

Public Member Methods inherited from Ssh2Connections::AbstractSsh2Connection
	constructor (string name, string description, string url, hash< auto > attributes={}, hash< auto > options={})
	creates the AbstractSsh2Connection object More...

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

hash< ConnectionSchemeInfo >	getConnectionSchemeInfoImpl ()
	Returns the ConnectionSchemeInfo hash for this object.

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

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

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.

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

private

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

The documentation for this class was generated from the following file: