twisted.spread.pb.RemoteReference(Serializable, styles.Ephemeral) class documentation

Part of twisted.spread.pb (View In Hierarchy)

Known subclasses: twisted.words.service.AvatarReference, twisted.words.service.PBGroupReference, twisted.words.service.PBMindReference

Implements interfaces: twisted.spread.interfaces.IUnjellyable

A translucent reference to a remote object.

I may be a reference to a flavors.ViewPoint, a flavors.Referenceable, or an IPerspective implementer (e.g., pb.Avatar). From the client's perspective, it is not possible to tell which except by convention.

I am a "translucent" reference because although no additional bookkeeping overhead is given to the application programmer for manipulating a reference, return values are asynchronous.

See also twisted.internet.defer.

Instance Variable broker The broker I am obtained through. (type: Broker)
Method __init__ (internal) Initialize me with a broker and a locally-unique ID.
Method notifyOnDisconnect Register a callback to be called if our broker gets disconnected.
Method dontNotifyOnDisconnect Remove a callback that was registered with notifyOnDisconnect.
Method jellyFor If I am being sent back to where I came from, serialize as a local backreference.
Method unjellyFor Unjelly myself for the jellier.
Method callRemote Asynchronously invoke a remote method.
Method remoteMethod
Method __cmp__
Method __hash__ Hash me.
Method __del__ Do distributed reference counting on finalization.
Method _disconnected Called if we are disconnected and have callbacks registered.

Inherited from Serializable:

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

Inherited from Jellyable (via Serializable):

Method getStateFor Undocumented

Inherited from Ephemeral:

Method __reduce__ Serialize any subclass of Ephemeral in a way which replaces it with Ephemeral itself.
Method __getstate__ Undocumented
Method __setstate__ Undocumented
broker =
The broker I am obtained through. (type: Broker)
def __init__(self, perspective, broker, luid, doRefCount):

(internal) Initialize me with a broker and a locally-unique ID.

The ID is unique only to the particular Perspective Broker instance.

def notifyOnDisconnect(self, callback):

Register a callback to be called if our broker gets disconnected.

Parameterscallbacka callable which will be called with one argument, this instance.
def dontNotifyOnDisconnect(self, callback):

Remove a callback that was registered with notifyOnDisconnect.

Parameterscallbacka callable
def _disconnected(self):

Called if we are disconnected and have callbacks registered.

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

If I am being sent back to where I came from, serialize as a local backreference.

def unjellyFor(self, unjellier, unjellyList):
from twisted.spread.interfaces.IUnjellyable
overridden in twisted.words.service.PBGroupReference

Unjelly myself for the jellier.

ParametersjellierA stateful object which exists for the lifetime of a single call to unjelly.
jellyListThe list which represents the jellied state of the object to be unjellied.
ReturnsThe object which results from unjellying.
def callRemote(self, _name, *args, **kw):

Asynchronously invoke a remote method.

Parameters_namethe name of the remote method to invoke (type: str)
argsarguments to serialize for the remote function
kwkeyword arguments to serialize for the remote function.
Returnsa Deferred which will be fired when the result of this remote call is received. (type: twisted.internet.defer.Deferred)
def remoteMethod(self, key):
ParameterskeyThe key.
ReturnsA RemoteMethod for this key.
def __cmp__(self, other):
Parametersotheranother RemoteReference to compare me to.
def __hash__(self):

Hash me.

def __del__(self):

Do distributed reference counting on finalization.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.