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

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

Known subclasses: twisted.web.distrib.ResourcePublisher

Implements interfaces: twisted.spread.flavors.IPBRoot

I provide a root object to pb.Brokers for a pb.BrokerFactory.

When a pb.BrokerFactory 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 pb.BrokerFactory is requesting to publish me as a root object.

Inherited from Jellyable (via Referenceable, Serializable):

Method getStateFor Undocumented

Inherited from Jellyable (via Referenceable, Serializable):

Method getStateFor Undocumented

Inherited from Jellyable (via Referenceable, Serializable):

Method getStateFor Undocumented
def rootObject(self, broker): (source)

A pb.BrokerFactory is requesting to publish me as a root object.

When a pb.BrokerFactory 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 2016-04-04 15:02:49.