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`.`publish`.`Publishable``

class documentation

`class Publishable(flavors.Cacheable): (source)`

Constructor: `Publishable(publishedID)`

View In Hierarchy

An object whose cached state persists across sessions.

Method | `__init__` | Undocumented
Method | `getStateToCacheAndObserveFor` | Get all necessary metadata to keep a clientside cache.
Method | `getStateToPublish` | Implement me to return state to copy as part of the publish phase.
Method | `getStateToPublishFor` | Implement me to special-case your state for a perspective.
Method | `republish` | Set the timestamp to current and (TODO) update all observers.
Method | `view_getStateToPublish` | (internal)
Instance Variable | `publishedID` | Undocumented
Instance Variable | `timestamp` | Undocumented

Inherited from `Cacheable`:

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` (via `Cacheable`):

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 `Cacheable`, `Copyable`):

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

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

Method | `getStateFor` | Undocumented

def __init__(self, publishedID): (source)

Undocumented

def getStateToCacheAndObserveFor(self, perspective, observer): (source)
overrides `twisted.spread.pb.Cacheable.getStateToCacheAndObserveFor`

Get all necessary metadata to keep a clientside cache.

def getStateToPublish(self): (source)

Implement me to return state to copy as part of the publish phase.

def getStateToPublishFor(self, perspective): (source)

Implement me to special-case your state for a perspective.

def republish(self): (source)

Set the timestamp to current and (TODO) update all observers.

def view_getStateToPublish(self, perspective): (source)

(internal)

publishedID = (source)

Undocumented

timestamp = (source)

Undocumented