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`.`Cacheable``

class documentation

`class Cacheable(Copyable): (source)`

Known subclasses: `twisted.spread.publish.Publishable`

View In Hierarchy

A cached instance.

This means that it's copied; but there is some logic to make sure that it's only copied once. Additionally, when state is retrieved, it is passed a "proto-reference" to the state as it will exist on the client.

XXX: The documentation for this class needs work, but it's the most complex part of PB and it is inherently difficult to explain.

Method | `getStateToCacheAndObserveFor` | Get state to cache on the client and client-cache reference to observe locally.
Method | `jellyFor` | Return an appropriate tuple to serialize me.
Method | `stoppedObserving` | This method is called when a client has stopped observing me.

Inherited from `Copyable`:

Method | `getStateToCopy` | Gather state to send when I am serialized for a peer.
Method | `getStateToCopyFor` | Gather state to send when I am serialized for a particular perspective.
Method | `getTypeToCopy` | Determine what type tag to send for me.
Method | `getTypeToCopyFor` | Determine what type tag to send for me.

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

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

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

Method | `getStateFor` | Undocumented

def getStateToCacheAndObserveFor(self, perspective, observer): (source)
overridden in `twisted.spread.publish.Publishable`

Get state to cache on the client and client-cache reference to observe locally.

This is similar to getStateToCopyFor, but it additionally passes in a reference to the client-side RemoteCache instance that will be created when it is unserialized. This allows Cacheable instances to keep their RemoteCaches up to date when they change, such that no changes can occur between the point at which the state is initially copied and the client receives it that are not propagated.

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

Return an appropriate tuple to serialize me.

Depending on whether this broker has cached me or not, this may return either a full state or a reference to an existing cache.

def stoppedObserving(self, perspective, observer): (source)

This method is called when a client has stopped observing me.

The 'observer' argument is the same as that passed in to getStateToCacheAndObserveFor.