twisted.conch.client.direct.SSHClientTransport : API documentation

Method	__init__	Undocumented
Method	connectionLost	When the underlying connection is closed, stop the running service (if any), and log out the avatar (if any).
Method	receiveError	Called when we receive a disconnect error message from the other side.
Method	sendDisconnect	Send a disconnect message to the other side and then disconnect.
Method	receiveDebug	Called when we receive a debug message from the other side.
Method	verifyHostKey	Returns a Deferred that gets a callback if it is a valid key, or an errback if not.
Method	setService	Set our service to service and start it running. If we were running a service previously, stop it first.
Method	connectionSecure	Called when the encryption has been set up. Generally, requestService() is called to run another service over the transport.

Inherited from BaseProtocol (via SSHClientTransport, SSHTransportBase, Protocol):

Method

makeConnection

Make a connection to a transport and a server.

Inherited from BaseProtocol (via SSHClientTransport, SSHTransportBase, Protocol):

Method

makeConnection

Make a connection to a transport and a server.

Inherited from BaseProtocol (via SSHClientTransport, SSHTransportBase, Protocol):

Method

makeConnection

Make a connection to a transport and a server.

Inherited from BaseProtocol (via SSHClientTransport, SSHTransportBase, Protocol):

Method

makeConnection

Make a connection to a transport and a server.

def __init__(self, factory): (source)

Undocumented

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.conch.ssh.transport.SSHTransportBase.connectionLost

When the underlying connection is closed, stop the running service (if any), and log out the avatar (if any).

Parameters reason The cause of the connection being closed. (type: twisted.python.failure.Failure)

def receiveError(self, code, desc): (source)

overrides twisted.conch.ssh.transport.SSHTransportBase.receiveError

Called when we receive a disconnect error message from the other side.

Parameters	reasonCode	the reason for the disconnect, one of the DISCONNECT_ values. (type: `int`)
	description	a human-readable description of the disconnection. (type: `str`)

def sendDisconnect(self, code, reason): (source)

overrides twisted.conch.ssh.transport.SSHTransportBase.sendDisconnect

Send a disconnect message to the other side and then disconnect.

Parameters	reason	the reason for the disconnect. Should be one of the DISCONNECT_* values. (type: `int`)
	desc	a descrption of the reason for the disconnection. (type: `str`)

def receiveDebug(self, alwaysDisplay, message, lang): (source)

overrides twisted.conch.ssh.transport.SSHTransportBase.receiveDebug

Called when we receive a debug message from the other side.

Parameters	alwaysDisplay	if True, this message should always be displayed. (type: `bool`)
	message	the debug message (type: `str`)
	lang	optionally the language the message is in. (type: `str`)

def verifyHostKey(self, pubKey, fingerprint): (source)

overrides twisted.conch.ssh.transport.SSHClientTransport.verifyHostKey

Returns a Deferred that gets a callback if it is a valid key, or an errback if not.

Parameters	hostKey	The host key to verify. (type: `bytes`)
	fingerprint	The fingerprint of the key. (type: `bytes`)
Returns	A deferred firing with `True` if the key is valid.

def setService(self, service): (source)

overrides twisted.conch.ssh.transport.SSHTransportBase.setService

Set our service to service and start it running. If we were running a service previously, stop it first.

Parameters service The service to attach. (type: SSHService)

def connectionSecure(self): (source)

overrides twisted.conch.ssh.transport.SSHClientTransport.connectionSecure

Called when the encryption has been set up. Generally, requestService() is called to run another service over the transport.

twisted.conch.client.direct.SSHClientTransport(transport.SSHClientTransport) class documentation

`twisted.conch.client.direct.SSHClientTransport(transport.SSHClientTransport)` class documentation