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`.`unix`.`SSHSessionForUnixConchUser``

class documentation

`class SSHSessionForUnixConchUser: (source)`

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

View In Hierarchy

Undocumented

Method | `__init__` | Construct an `SSHSessionForUnixConchUser`.
Method | `addUTMPEntry` | 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 | `getPtyOwnership` | Undocumented
Method | `openShell` | Open a shell and connect it to proto.
Method | `setModes` | Undocumented
Method | `windowChanged` | Called when the size of the remote screen has changed.
Instance Variable | `avatar` | Undocumented
Instance Variable | `environ` | Undocumented
Instance Variable | `modes` | Undocumented
Instance Variable | `oldWrite` | Undocumented
Instance Variable | `pty` | Undocumented
Instance Variable | `ptyTuple` | Undocumented
Instance Variable | `winSize` | Undocumented
Method | `_writeHack` | Hack to send ignore messages when we aren't echoing.
Class Variable | `_log` | Undocumented
Instance Variable | `_reactor` | Undocumented

def __init__(self, avatar, reactor=None): (source)

Construct an `SSHSessionForUnixConchUser`.

Parameters
avatar | The `UnixConchUser` for whom this is an SSH session.
reactor | An `IReactorProcess` used to handle shell and exec requests. Uses the default reactor if None.

def addUTMPEntry(self, loggedIn=1): (source)

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, modes): (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 getPtyOwnership(self): (source)

Undocumented

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

Open a shell and connect it to proto.

Parameters
proto | a `ProcessProtocol` instance.

def setModes(self): (source)

Undocumented

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

Called when the size of the remote screen has changed.

avatar = (source)

Undocumented

environ: `dict[str, str]` = (source)

Undocumented

modes = (source)

Undocumented

oldWrite = (source)

Undocumented

pty = (source)

Undocumented

ptyTuple = (source)

Undocumented

winSize = (source)

Undocumented

def _writeHack(self, data): (source)

Hack to send ignore messages when we aren't echoing.

_log = (source)

Undocumented

_reactor = (source)

Undocumented