Package twisted :: Package spread :: Module flavors :: Class RemoteCopy
[show private | hide private]
[frames | no frames]

Class RemoteCopy

Unjellyable --+
              |
             RemoteCopy

Known Subclasses:
ClientProfile, Command, CommandResult, CVSEntity, DataPacket, DataRequest, Event, ListenRequest, ProfileRequest, Script, TimeFrame

I am a remote copy of a Copyable object.

When the state from a Copyable object is received, an instance will be created based on the copy tags table (see setUnjellyableForClass) and sent the setCopyableState message. I provide a reasonable default implementation of that message; subclass me if you wish to serve as a copier for remote data.

NOTE: copiers are invoked with no arguments. Do not implement a constructor which requires args in a subclass of RemoteCopy!
Method Summary
  setCopyableState(self, state)
I will be invoked with the state to copy locally.
  unjellyFor(self, unjellier, jellyList)
    Inherited from Unjellyable
  setStateFor(self, unjellier, state)

Class Variable Summary
    Inherited from Unjellyable
Implements __implemented__ = <implementedBy twisted.spread.jelly.Un...
_implementsTuple __implements__ = (<MetaInterface twisted.spread.interfac...
ClassProvides __providedBy__ = <zope.interface.declarations.ClassProvi...
ClassProvides __provides__ = <zope.interface.declarations.ClassProvide...

Method Details

setCopyableState(self, state)

I will be invoked with the state to copy locally.

'state' is the data returned from the remote object's 'getStateToCopyFor' method, which will often be the remote object's dictionary (or a filtered approximation of it depending on my peer's perspective).

Generated by Epydoc 2.1 on Thu Oct 20 15:30:26 2005 http://epydoc.sf.net