Table of Contents

Class: Cacheable | Twisted-0.17.4/twisted/spread/flavors.py
--- | ---

### A cached instance.

This means that it's copied; but there is some logic to make sure that it's only copied once. Additionally, when state is retrieved, it is passed a "proto-reference" to the state as it will exist on the client.

XXX: The documentation for this class needs work, but it's the most complex part of PB and it is inherently difficult to explain.

Base Classes |
--- | ---

Copyable

Serializable

Jellyable

Methods |
--- | ---
getStateToCacheAndObserveFor jellyFor stoppedObserving
| getStateToCacheAndObserveFor

    getStateToCacheAndObserveFor (
            self,
            perspective,
            observer,
            )

### Get state to cache on the client and client-cache reference to observe locally.

This is similiar to getStateToCopyFor, but it additionally passes in a reference to the client-side RemoteCache instance that will be created when it is unserialized. This allows Cacheable instances to keep their RemoteCaches up to date when they change, such that no changes can occurr between the point at which the state is initially copied and the client receives it that are not propogated.

| jellyFor

    jellyFor ( self,  jellier )

### Return an appropriate tuple to serialize me.

Depending on whether this broker has cached me or not, this may return either a full state or a reference to an existing cache.

| stoppedObserving

    stoppedObserving (
            self,
            perspective,
            observer,
            )

### This method is called when a client has stopped observing me.

The `observer` argument is the same as that passed in to getStateToCacheAndObserveFor.

Table of Contents

This document was automatically generated on Sat Apr 20 01:31:32 2002 by HappyDoc version 2.0