# ``twisted`.`conch`.`endpoints`.`_ConnectionReady``

class documentation

`class _ConnectionReady(SSHConnection): (source)`

View In Hierarchy

`_ConnectionReady` is an `SSHConnection` (an SSH service) which only propagates the serviceStarted event to a `Deferred` to be handled elsewhere.

Method | `__init__` |
Method | `serviceStarted` | When the SSH connection service this object represents is ready to be used, fire the `connectionReady` `Deferred` to publish that event to some other interested party.
Instance Variable | `_ready` | Undocumented

Inherited from `SSHConnection`:

Method | `adjustWindow` | Tell the other side that we will receive more data. This should not normally need to be called as it is managed automatically.
Method | `channelClosed` | No summary
Method | `getChannel` | No summary
Method | `gotGlobalRequest` | No summary
Method | `openChannel` | Open a new channel on this connection.
Method | `sendClose` | Close a channel.
Method | `sendData` | Send data to a channel. This should not normally be used: instead use channel.write(data) as it manages the window automatically.
Method | `sendEOF` | Send an EOF (End of File) for a channel.
Method | `sendExtendedData` | 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 | `sendGlobalRequest` | Send a global request for this connection. Current this is only used for remote->local TCP forwarding.
Method | `sendRequest` | Send a request to a channel.
Method | `serviceStopped` | 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 | `channelsToRemoteChannel` | 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 `Deferred`s.
Instance Variable | `localChannelID` | the next number to use as a local channel ID.
Instance Variable | `localToRemoteChannel` | a `dict` mapping a local channel ID to a remote channel ID.
Instance Variable | `transport` | Undocumented
Method | `_cbChannelRequest` | 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 | `_cleanupGlobalDeferreds` | 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 | `_ebChannelRequest` | 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 | `logPrefix` | Undocumented
Method | `packetReceived` | called when we receive a packet on the transport
Class Variable | `protocolMessages` | Undocumented

def __init__(self, ready): (source)
overrides `twisted.conch.ssh.connection.SSHConnection.__init__`

Parameters
ready | A `Deferred` which should be fired when serviceStarted happens.

def serviceStarted(self): (source)
overrides `twisted.conch.ssh.connection.SSHConnection.serviceStarted`
When the SSH connection service this object represents is ready to be used, fire the `connectionReady` `Deferred` to publish that event to some other interested party.
_ready = (source)

Undocumented