Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`conch`.`ssh`.`forwarding`.`SSHConnectForwardingChannel``

class documentation

`class SSHConnectForwardingChannel(channel.SSHChannel): (source)`

Known subclasses: `twisted.conch.scripts.conch.SSHConnectForwardingChannel`

View In Hierarchy

Channel used for handling server side forwarding request. It acts as a client for the remote forwarding destination.

Method | `__init__` | Undocumented
Method | `channelOpen` | See: `channel.SSHChannel`
Method | `closed` | See: `channel.SSHChannel`
Method | `dataReceived` | See: `channel.SSHChannel`
Instance Variable | `client` | Protocol connected to the forwarding destination.
Instance Variable | `clientBuf` | Data received while forwarding channel is not yet connected.
Instance Variable | `hostport` | `(host, port)` requested by client as forwarding destination.
Method | `_close` | Called when failed to connect to the forwarding destination.
Method | `_setClient` | Called when the connection was established to the forwarding destination.
Instance Variable | `_channelOpenDeferred` | Deferred used in testing to check the result of `channelOpen`.
Variable | `_reactor` | Reactor used for TCP connections.

Inherited from `SSHChannel`:

Method | `__bytes__` | Return a byte string representation of the channel
Method | `__str__` | Undocumented
Method | `addWindowBytes` | Called when bytes are added to the remote window. By default it clears the data buffers.
Method | `closeReceived` | Called when the other side has closed the channel.
Method | `eofReceived` | Called when the other side will send no more data.
Method | `extReceived` | Called when we receive extended data (usually standard error).
Method | `getHost` | See: `ITransport.getHost`
Method | `getPeer` | See: `ITransport.getPeer`
Method | `logPrefix` | Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines.
Method | `loseConnection` | Close the channel if there is no buferred data. Otherwise, note the request and return.
Method | `openFailed` | Called when the open failed for some reason. reason.desc is a string descrption, reason.code the SSH error code.
Method | `requestReceived` | Called when a request is sent to this channel. By default it delegates to self.request_<requestType>. If this function returns true, the request succeeded, otherwise it failed.
Method | `startWriting` | Called when the remote buffer has more room, as a hint to continue writing.
Method | `stopWriting` | Called when the remote buffer is full, as a hint to stop writing. This can be ignored, but it can be helpful.
Method | `write` | Write some data to the channel. If there is not enough remote window available, buffer until it is. Otherwise, split the data into packets of length remoteMaxPacket and send them.
Method | `writeExtended` | Send extended data to this channel. If there is not enough remote window available, buffer until there is. Otherwise, split the data into packets of length remoteMaxPacket and send them.
Method | `writeSequence` | Part of the Transport interface. Write a list of strings to the channel.
Instance Variable | `areWriting` | Undocumented
Instance Variable | `avatar` | an avatar for the logged-in user (if a server channel)
Instance Variable | `buf` | Undocumented
Instance Variable | `closing` | Undocumented
Instance Variable | `conn` | the connection this channel is multiplexed through.
Instance Variable | `data` | any data to send to the other side when the channel is requested.
Instance Variable | `extBuf` | Undocumented
Instance Variable | `id` | Undocumented
Instance Variable | `localClosed` | True if we aren't accepting more data.
Instance Variable | `localMaxPacket` | the maximum size of packet we will accept in bytes.
Instance Variable | `localWindowLeft` | how many bytes are left in the local window.
Instance Variable | `localWindowSize` | the maximum size of the local window in bytes.
Instance Variable | `name` | the name of the channel.
Instance Variable | `remoteClosed` | True if the other side isn't accepting more data.
Instance Variable | `remoteMaxPacket` | the maximum size of a packet the remote side will accept in bytes.
Instance Variable | `remoteWindowLeft` | how many bytes are left in the remote window.
Instance Variable | `specificData` | Undocumented
Class Variable | `_log` | Undocumented

def __init__(self, hostport, *args, **kw): (source)
overrides `twisted.conch.ssh.channel.SSHChannel.__init__`

Undocumented

def channelOpen(self, specificData): (source)
overrides `twisted.conch.ssh.channel.SSHChannel.channelOpen`

See: `channel.SSHChannel`

def closed(self): (source)
overrides `twisted.conch.ssh.channel.SSHChannel.closed`

See: `channel.SSHChannel`

def dataReceived(self, data): (source)
overrides `twisted.conch.ssh.channel.SSHChannel.dataReceived`

See: `channel.SSHChannel`

client: `protocol.Protocol` = (source)

Protocol connected to the forwarding destination.

clientBuf: `bytes` = (source)

Data received while forwarding channel is not yet connected.

hostport: `tuple` or a `sequence` = (source)

`(host, port)` requested by client as forwarding destination.

def _close(self, reason): (source)

Called when failed to connect to the forwarding destination.

Parameters
reason:`twisted.python.failure.Failure` | Reason why connection failed.

def _setClient(self, client): (source)

Called when the connection was established to the forwarding destination.

Parameters
client:`protocol.Protocol` | Client protocol connected to the forwarding destination.

_channelOpenDeferred: `twisted.internet.defer.Deferred` = (source)

Deferred used in testing to check the result of `channelOpen`.

_reactor: A reactor. = (source)

Reactor used for TCP connections.