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

interface documentation

`class IPerspective(Interface): (source)`

Known implementations: `twisted.spread.pb.Avatar`

View In Hierarchy

per*spec*tive, n. : The relationship of aspects of a subject to each other and to a whole: 'a perspective of history'; 'a need to view the problem in the proper perspective'.

This is a Perspective Broker-specific wrapper for an avatar. That is to say, a PB-published view on to the business logic for the system's concept of a 'user'.

The concept of attached/detached is no longer implemented by the framework. The realm is expected to implement such semantics if needed.

Method | `perspectiveMessageReceived` | This method is called when a network message is received.

def perspectiveMessageReceived(broker, message, args, kwargs): (source)

This method is called when a network message is received.

Parameters
broker | The Perspective Broker.
message:str | The name of the method called by the other end.
args:list in jelly format | The arguments that were passed by the other end. It is recommend that you use the `unserialize' method of the broker to decode this.
kwargs:dict in jelly format | The keyword arguments that were passed by the other end. It is recommended that you use the `unserialize' method of the broker to decode this.
Returns
A jelly list. | It is recommended that you use the `serialize' method of the broker on whatever object you need to return to generate the return value.