twisted.spread.publish.Publishable

class documentation

class twisted.spread.publish.Publishable(flavors.Cacheable): (source)

View In Hierarchy

An object whose cached state persists across sessions.

Method __init__ Undocumented
Instance Variable publishedID Undocumented
Method republish Set the timestamp to current and (TODO) update all observers.
Instance Variable timestamp Undocumented
Method view_getStateToPublish (internal)
Method getStateToPublishFor Implement me to special-case your state for a perspective.
Method getStateToPublish Implement me to return state to copy as part of the publish phase.
Method getStateToCacheAndObserveFor Get all necessary metadata to keep a clientside cache.

Inherited from Cacheable:

Method jellyFor Return an appropriate tuple to serialize me.
Method stoppedObserving This method is called when a client has stopped observing me.

Inherited from Copyable (via Cacheable):

Method getStateToCopy Gather state to send when I am serialized for a peer.
Method getStateToCopyFor Gather state to send when I am serialized for a particular perspective.
Method getTypeToCopy Determine what type tag to send for me.
Method getTypeToCopyFor Determine what type tag to send for me.

Inherited from Serializable (via Cacheable, Copyable):

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

Inherited from Jellyable (via Cacheable, Copyable, Serializable):

Method getStateFor Undocumented
def __init__(self, publishedID): (source)

Undocumented

publishedID = (source)

Undocumented

def republish(self): (source)

Set the timestamp to current and (TODO) update all observers.

timestamp = (source)

Undocumented

def view_getStateToPublish(self, perspective): (source)

(internal)

def getStateToPublishFor(self, perspective): (source)

Implement me to special-case your state for a perspective.

def getStateToPublish(self): (source)

Implement me to return state to copy as part of the publish phase.

def getStateToCacheAndObserveFor(self, perspective, observer): (source)
overrides twisted.spread.pb.Cacheable.getStateToCacheAndObserveFor

Get all necessary metadata to keep a clientside cache.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.