twisted.spread.pb.Root(Referenceable) class documentation

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

Known subclasses: twisted.spread.test.test_pb.CachedReturner, twisted.spread.test.test_pb.Echoer, twisted.spread.test.test_pbfailure.SimpleRoot, twisted.web.distrib.ResourcePublisher

Implements interfaces: twisted.spread.flavors.IPBRoot

I provide a root object to pb.Brokers for a pb.PBClientFactory or pb.PBServerFactory.

When a factory produces a pb.Broker, it supplies that pb.Broker with an object named "root". That object is obtained by calling my rootObject method.

Method rootObject A factory is requesting to publish me as a root object.

Inherited from Referenceable:

Method remoteMessageReceived A remote message has been received. Dispatch it appropriately.
Method jellyFor (internal)

Inherited from Serializable (via Referenceable):

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

Inherited from Jellyable (via Referenceable, Serializable):

Method getStateFor Undocumented
def rootObject(self, broker):

A factory is requesting to publish me as a root object.

When a factory is sending me as the root object, this method will be invoked to allow per-broker versions of an object. By default I return myself.

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