t.c.e._NewConnectionHelper(object) : class documentation

Part of twisted.conch.endpoints View Source View In Hierarchy

_NewConnectionHelper implements _ISSHConnectionCreator by establishing a brand new SSH connection, securing it, and authenticating.
Method __init__
Method secureConnection Create and return a new SSH connection which has been secured and on which authentication has already happened.
Method cleanupConnection Clean up the connection by closing it. The command running on the endpoint has ended so the connection is no longer needed.
Method _opener Open the tty if possible, otherwise give back a file-like object from which b"no" can be read.
Class Method _knownHosts
def __init__(self, reactor, hostname, port, command, username, keys, password, agentEndpoint, knownHosts, ui, tty=FilePath('/dev/tty')): (source)
ParametersttyThe path of the tty device to use in case ui is None. (type: FilePath)
See AlsoSSHCommandClientEndpoint.newConnection
def _opener(self): (source)
Open the tty if possible, otherwise give back a file-like object from which b"no" can be read.

For use as the opener argument to ConsoleUI.

@classmethod
def _knownHosts(cls): (source)
ReturnsA KnownHostsFile instance pointed at the user's personal known hosts file.
def secureConnection(self): (source)
Create and return a new SSH connection which has been secured and on which authentication has already happened.
ReturnsA Deferred which fires with the ready-to-use connection or with a failure if something prevents the connection from being setup, secured, or authenticated.
def cleanupConnection(self, connection, immediate): (source)
Clean up the connection by closing it. The command running on the endpoint has ended so the connection is no longer needed.
ParametersconnectionThe SSHConnection to close. (type: SSHConnection)
immediateWhether to close connection immediately. (type: bool.)
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.