twisted.conch.endpoints._ISSHConnectionCreator

interface documentation

class _ISSHConnectionCreator(Interface): (source)

Known implementations: twisted.conch.endpoints._ExistingConnectionHelper, twisted.conch.endpoints._NewConnectionHelper

View In Hierarchy

An _ISSHConnectionCreator knows how to create SSH connections somehow.

Method	`cleanupConnection`	Perform cleanup necessary for a connection object previously returned from this creator's `secureConnection` method.
Method	`secureConnection`	Return a new, connected, secured, but not yet authenticated instance of `twisted.conch.ssh.transport.SSHServerTransport` or `twisted.conch.ssh.transport.SSHClientTransport`.

def cleanupConnection(connection, immediate): (source)

Perform cleanup necessary for a connection object previously returned from this creator's secureConnection method.

Parameters
connection	An `twisted.conch.ssh.transport.SSHServerTransport` or `twisted.conch.ssh.transport.SSHClientTransport` returned by a previous call to `secureConnection`. It is no longer needed by the caller of that method and may be closed or otherwise cleaned up as necessary.
immediate	If `True` don't wait for any network communication, just close the connection immediately and as aggressively as necessary.

def secureConnection(): (source)

Return a new, connected, secured, but not yet authenticated instance of twisted.conch.ssh.transport.SSHServerTransport or twisted.conch.ssh.transport.SSHClientTransport.