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`.`spread`.`pb`.`Viewable``

class documentation

`class Viewable(Serializable): (source)`

Known subclasses: `twisted.web.twcgi.CGIProcessProtocol`

View In Hierarchy

I will be converted to a `ViewPoint` when passed to or returned from a remote method.

The beginning of a peer's interaction with a PB Service is always through a perspective. However, if a `perspective_xxx` method returns a Viewable, it will be serialized to the peer as a response to that method.

Method | `jellyFor` | Serialize a `ViewPoint` for me and the perspective of the given broker.

Inherited from `Serializable`:

Method | `processUniqueID` | Return an ID which uniquely represents this object for this process.

Inherited from `Jellyable` (via `Serializable`):

Method | `getStateFor` | Undocumented

def jellyFor(self, jellier): (source)
from `twisted.spread.interfaces.IJellyable`
overrides `twisted.spread.pb.Jellyable.jellyFor`

Serialize a `ViewPoint` for me and the perspective of the given broker.