Qore Ssh2Connections Module Reference  1.0
Ssh2Connections::AbstractSsh2Connection Class Reference

abstract base class for ssh module connections More...

Inheritance diagram for Ssh2Connections::AbstractSsh2Connection:

Public Member Functions

 constructor (string name, string desc, string url, bool monitor, *hash opts, hash urlh)
 creates the SftpConnection object More...
 
hash getOptions ()
 returns valid options More...
 

Detailed Description

abstract base class for ssh module connections

supports the following option:

  • "keyfile": a path to a private key file in PEM format to use for key-based authentication

Member Function Documentation

◆ constructor()

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

creates the SftpConnection object

Parameters
namethe name of the connection
descconnection description
urlconnection URL
monitormonitoring flag
optsconnection options
urlhbroken down URL hash (as returned by Qore::parse_url())

◆ getOptions()

hash Ssh2Connections::AbstractSsh2Connection::getOptions ( )

returns valid options

Returns
a hash with a single key: "keyfile"