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`.`manhole_ssh`.`TerminalSession``

class documentation

`class TerminalSession(components.Adapter): (source)`

Implements interfaces: `twisted.conch.interfaces.ISession`

View In Hierarchy

Undocumented

Method | `closed` | Called when the session is closed.
Method | `eofReceived` | Called when the other side has indicated no more data will be sent.
Method | `execCommand` | Execute a command.
Method | `getPty` | Get a pseudo-terminal for use by a shell or command.
Method | `openShell` | Open a shell and connect it to proto.
Method | `windowChanged` | Called when the size of the remote screen has changed.
Instance Variable | `height` | Undocumented
Instance Variable | `width` | Undocumented

Inherited from `Adapter`:

Method | `__conform__` | I forward __conform__ to self.original if it has it, otherwise I simply return None.
Method | `__init__` | Set my 'original' attribute to be the object I am adapting.
Method | `isuper` | Forward isuper to self.original
Class Variable | `multiComponent` | If this adapter is persistent, should it be automatically registered for all appropriate interfaces.
Class Variable | `temporaryAdapter` | If this is True, the adapter will not be persisted on the Componentized.
Instance Variable | `original` | Undocumented

def closed(self): (source)
from `twisted.conch.interfaces.ISession`

Called when the session is closed.

def eofReceived(self): (source)
from `twisted.conch.interfaces.ISession`

Called when the other side has indicated no more data will be sent.

def execCommand(self, proto, cmd): (source)
from `twisted.conch.interfaces.ISession`

Execute a command.

Parameters
proto | a `ProcessProtocol` instance.
cmd | Undocumented

def getPty(self, term, windowSize, attrs): (source)
from `twisted.conch.interfaces.ISession`

Get a pseudo-terminal for use by a shell or command.

If a pseudo-terminal is not available, or the request otherwise fails, raise an exception.

def openShell(self, proto): (source)
from `twisted.conch.interfaces.ISession`

Open a shell and connect it to proto.

Parameters
proto | a `ProcessProtocol` instance.

def windowChanged(self, newWindowSize): (source)
from `twisted.conch.interfaces.ISession`

Called when the size of the remote screen has changed.

height = (source)

Undocumented

width = (source)

Undocumented