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`.`client`.`agent`.`SSHAgentClient``

class documentation

`class SSHAgentClient(agent.SSHAgentClient): (source)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `getPublicKey` | Return a `Key` from the first blob in `self.blobs`, if any, or return `None`.
Method | `getPublicKeys` | Undocumented
Instance Variable | `blobs` | Undocumented
Method | `_cbPublicKeys` | Undocumented
Class Variable | `_log` | Undocumented

Inherited from `SSHAgentClient`:

Method | `addIdentity` | Add a private key blob to the agent's collection of keys.
Method | `dataReceived` | Called whenever data is received.
Method | `removeAllIdentities` | Remove all keys from the running agent.
Method | `removeIdentity` | Remove the private key corresponding to the public key in blob from the running agent.
Method | `requestIdentities` | No summary
Method | `sendRequest` | Undocumented
Method | `signData` | Request that the agent sign the given `data` with the private key which corresponds to the public key given by `blob`. The private key should have been added to the agent already.
Instance Variable | `buf` | Undocumented
Instance Variable | `deferreds` | Undocumented
Method | `_cbRequestIdentities` | Unpack a collection of identities into a list of tuples comprised of public key blobs and comments.
Method | `_cbSignData` | Undocumented

Inherited from `Protocol` (via `SSHAgentClient`):

Method | `connectionLost` | Called when the connection is shut down.
Method | `logPrefix` | Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable | `factory` | Undocumented

Inherited from `BaseProtocol` (via `SSHAgentClient`, `Protocol`):

Method | `connectionMade` | Called when a connection is made.
Method | `makeConnection` | Make a connection to a transport and a server.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

def __init__(self): (source)
overrides `twisted.conch.ssh.agent.SSHAgentClient.__init__`

Undocumented

def getPublicKey(self): (source)

Return a `Key` from the first blob in `self.blobs`, if any, or return `None`.

def getPublicKeys(self): (source)

Undocumented

blobs = (source)

Undocumented

def _cbPublicKeys(self, blobcomm): (source)

Undocumented

_log = (source)

Undocumented