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

class documentation

`class RemotePublished(flavors.RemoteCache): (source)`

View In Hierarchy

The local representation of remote Publishable object.

Method | `__getstate__` | Undocumented
Method | `activated` | Implement this method if you want to be notified when your publishable subclass is activated.
Method | `callWhenActivated` | Externally register for notification when this publishable has received all relevant data.
Method | `getFileName` | Undocumented
Method | `setCopyableState` | I will be invoked with the state to copy locally.
Instance Variable | `isActivated` | Undocumented
Method | `_cbGotUpdate` | Undocumented
Instance Variable | `_activationListeners` | Undocumented
Instance Variable | `_wasCleanWhenLoaded` | Undocumented

Inherited from `RemoteCache`:

Method | `__cmp__` | Compare me [to another RemoteCache.
Method | `__del__` | Do distributed reference counting on finalize.
Method | `__hash__` | Hash me.
Method | `jellyFor` | serialize me (only for the broker I'm for) as the original cached reference
Method | `remoteMessageReceived` | A remote message has been received. Dispatch it appropriately.
Method | `unjellyFor` | Perform the inverse operation of `Jellyable.jellyFor`.
Instance Variable | `__dict__` | Undocumented
Instance Variable | `broker` | Undocumented
Instance Variable | `luid` | Undocumented
Method | `_borgify` | Create a new object that shares its state (i.e. its `__dict__`) and type with this object, but does not share its identity.

Inherited from `Unjellyable` (via `RemoteCache`, `RemoteCopy`):

Method | `setStateFor` | Undocumented

Inherited from `Serializable` (via `RemoteCache`, `RemoteCopy`, `Unjellyable`):

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

Inherited from `Jellyable` (via `RemoteCache`, `RemoteCopy`, `Unjellyable`, `Serializable`):

Method | `getStateFor` | Undocumented

def __getstate__(self): (source)

Undocumented

def activated(self): (source)

Implement this method if you want to be notified when your publishable subclass is activated.

def callWhenActivated(self, callback): (source)

Externally register for notification when this publishable has received all relevant data.

def getFileName(self, ext='pub'): (source)

Undocumented

def setCopyableState(self, state): (source)
overrides `twisted.spread.pb.RemoteCopy.setCopyableState`

I will be invoked with the state to copy locally.

'state' is the data returned from the remote object's 'getStateToCopyFor' method, which will often be the remote object's dictionary (or a filtered approximation of it depending on my peer's perspective).

isActivated: `int` = (source)

Undocumented

def _cbGotUpdate(self, newState): (source)

Undocumented

_activationListeners: `list` = (source)

Undocumented

_wasCleanWhenLoaded: `int` = (source)

Undocumented