Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

Payload Class Reference

Inheritance diagram for Payload:

IPayload ClusterEntry InvalidatorPayload Message PathMapping QueuedEntry RollCall NullMessage Task List of all members.

Public Member Functions

void destroy ()
long getTime ()
void setTime (long time)
void read (IReader reader)
void write (IWriter writer)
Object create (IReader reader)
Object create ()
char[] getGuid ()

Private Attributes

ulong time

Detailed Description

Base-class for entries placed into both the cache and cluster framework

Definition at line 47 of file Payload.d.


Member Function Documentation

void destroy  )  [inline]
 

Destroy this payload. Often used to return instances to a freelist, or otherwise release resources.

Reimplemented from IPayload.

Reimplemented in QueuedEntry, InvalidatorPayload, and ClusterEntry.

Definition at line 58 of file Payload.d.

long getTime  )  [inline]
 

Return the timestamp associated with this payload

Reimplemented from IPayload.

Definition at line 68 of file Payload.d.

References time.

Referenced by ChannelCache::lockWhereInvalid().

void setTime long  time  )  [inline]
 

Set the timestamp of this payload

Reimplemented from IPayload.

Definition at line 79 of file Payload.d.

References time.

void read IReader  reader  )  [inline]
 

Recover the timestamp from the provided reader

Reimplemented from IReadable.

Reimplemented in InvalidatorPayload, Message, Task, and RollCall.

Definition at line 90 of file Payload.d.

References IReader::get(), and time.

Referenced by create(), testProtocol(), and testRemoteCacheLoader().

void write IWriter  writer  )  [inline]
 

Emit our timestamp to the provided writer

Reimplemented from IWritable.

Reimplemented in InvalidatorPayload, Message, Task, and RollCall.

Definition at line 101 of file Payload.d.

References IWriter::put(), and time.

Referenced by testProtocol().

Object create IReader  reader  )  [inline]
 

Create a new instance of a payload, and populate it via read() using the specified reader

Reimplemented from IPickleFactory.

Reimplemented in Message, and Task.

Definition at line 113 of file Payload.d.

References create(), and read().

Object create  )  [inline]
 

Overridable create method that simply instantiates a new instance. May be used to allocate subclassses from a freelist

Reimplemented in InvalidatorPayload, Message, NullMessage, Task, ClusterEntry, and RollCall.

Definition at line 128 of file Payload.d.

Referenced by create(), and testProtocol().

char [] getGuid  )  [inline]
 

Return the guid for this payload. This should be unique per payload class, if said class is used in conjunction with the clustering facilities. Inspected by the Pickle utilitiy classes.

Reimplemented from IPickle.

Reimplemented in InvalidatorPayload, Message, NullMessage, Task, and RollCall.

Definition at line 142 of file Payload.d.

Referenced by testProtocol().


Member Data Documentation

ulong time [private]
 

Definition at line 49 of file Payload.d.

Referenced by getTime(), read(), and write().


The documentation for this class was generated from the following file:
Generated on Sun Nov 7 19:07:08 2004 for Mango by doxygen 1.3.6