Undocumented
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)

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

ParametersreasonThe cause of the connection being closed. (type: twisted.python.failure.Failure)
def receiveError(self, code, desc): (source)

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

ParametersreasonCodethe reason for the disconnect, one of the DISCONNECT_ values. (type: int)
descriptiona human-readable description of the disconnection. (type: str)
def sendDisconnect(self, code, reason): (source)

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

Parametersreasonthe reason for the disconnect. Should be one of the DISCONNECT_* values. (type: int)
desca descrption of the reason for the disconnection. (type: str)
def receiveDebug(self, alwaysDisplay, message, lang): (source)

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

ParametersalwaysDisplayif True, this message should always be displayed. (type: bool)
messagethe debug message (type: str)
langoptionally the language the message is in. (type: str)
def verifyHostKey(self, pubKey, fingerprint): (source)

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

ParametershostKeyThe host key to verify. (type: bytes)
fingerprintThe fingerprint of the key. (type: bytes)
ReturnsA deferred firing with True if the key is valid.
def setService(self, service): (source)

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

ParametersserviceThe service to attach. (type: SSHService)
def connectionSecure(self): (source)

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

API Documentation for Twisted, generated by pydoctor at 2016-05-18 16:01:36.