class documentation

class SSHConnection(connection.SSHConnection): (source)

View In Hierarchy

Undocumented

Method service​Started called when the service is active on the transport.

Inherited from SSHConnection:

Method __init__ Undocumented
Method adjust​Window Tell the other side that we will receive more data. This should not normally need to be called as it is managed automatically.
Method channel​Closed No summary
Method get​Channel No summary
Method got​Global​Request No summary
Method open​Channel Open a new channel on this connection.
Method send​Close Close a channel.
Method send​Data Send data to a channel. This should not normally be used: instead use channel.write(data) as it manages the window automatically.
Method send​EOF Send an EOF (End of File) for a channel.
Method send​Extended​Data Send extended data to a channel. This should not normally be used: instead use channel.writeExtendedData(data, dataType) as it manages the window automatically.
Method send​Global​Request Send a global request for this connection. Current this is only used for remote->local TCP forwarding.
Method send​Request Send a request to a channel.
Method service​Stopped Called when the connection is stopped.
Method ssh_​CHANNEL_​CLOSE The other side is closing its end; it does not want to receive any more data. Payload:: uint32 local channel number
Method ssh_​CHANNEL_​DATA The other side is sending us data. Payload:: uint32 local channel number string data
Method ssh_​CHANNEL_​EOF The other side is not sending any more data. Payload:: uint32 local channel number
Method ssh_​CHANNEL_​EXTENDED_​DATA No summary
Method ssh_​CHANNEL_​FAILURE Our channel request to the other side failed. Payload:: uint32 local channel number
Method ssh_​CHANNEL_​OPEN No summary
Method ssh_​CHANNEL_​OPEN_​CONFIRMATION No summary
Method ssh_​CHANNEL_​OPEN_​FAILURE No summary
Method ssh_​CHANNEL_​REQUEST No summary
Method ssh_​CHANNEL_​SUCCESS Our channel request to the other side succeeded. Payload:: uint32 local channel number
Method ssh_​CHANNEL_​WINDOW_​ADJUST The other side is adding bytes to its window. Payload:: uint32 local channel number uint32 bytes to add
Method ssh_​GLOBAL_​REQUEST No summary
Method ssh_​REQUEST_​FAILURE Our global request failed. Get the appropriate Deferred and errback it with the packet we received.
Method ssh_​REQUEST_​SUCCESS Our global request succeeded. Get the appropriate Deferred and call it back with the packet we received.
Class Variable name Undocumented
Instance Variable channels a dict mapping a local channel ID to SSHChannel subclasses.
Instance Variable channels​To​Remote​Channel a dict mapping a SSHChannel subclass to remote channel ID.
Instance Variable deferreds a dict mapping a local channel ID to a list of Deferreds for outstanding channel requests. Also, the 'global' key stores the list of pending global request Deferreds.
Instance Variable local​Channel​ID the next number to use as a local channel ID.
Instance Variable local​To​Remote​Channel a dict mapping a local channel ID to a remote channel ID.
Instance Variable transport Undocumented
Method _cb​Channel​Request Called back if the other side wanted a reply to a channel request. If the result is true, send a MSG_CHANNEL_SUCCESS. Otherwise, raise a error.ConchError
Method _cleanup​Global​Deferreds All pending requests that have returned a deferred must be errbacked when this service is stopped, otherwise they might be left uncalled and uncallable.
Method _eb​Channel​Request Called if the other wisde wanted a reply to the channel requeset and the channel request failed.
Class Variable _log Undocumented

Inherited from SSHService (via SSHConnection):

Method log​Prefix Undocumented
Method packet​Received called when we receive a packet on the transport
Class Variable protocol​Messages Undocumented
def serviceStarted(self): (source)
called when the service is active on the transport.