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

Payload.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file Payload.d
00004         
00005         Copyright (c) 2004 Kris Bell
00006         
00007         This software is provided 'as-is', without any express or implied
00008         warranty. In no event will the authors be held liable for damages
00009         of any kind arising from the use of this software.
00010         
00011         Permission is hereby granted to anyone to use this software for any 
00012         purpose, including commercial applications, and to alter it and/or 
00013         redistribute it freely, subject to the following restrictions:
00014         
00015         1. The origin of this software must not be misrepresented; you must 
00016            not claim that you wrote the original software. If you use this 
00017            software in a product, an acknowledgment within documentation of 
00018            said product would be appreciated but is not required.
00019 
00020         2. Altered source versions must be plainly marked as such, and must 
00021            not be misrepresented as being the original software.
00022 
00023         3. This notice may not be removed or altered from any distribution
00024            of the source.
00025 
00026         4. Derivative works are permitted, but they must carry this notice
00027            in full and credit the original source.
00028 
00029 
00030                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
00031 
00032         
00033         @version        Initial version, April 2004      
00034         @author         Kris
00035 
00036 
00037 *******************************************************************************/
00038 
00039 module mango.cache.Payload;
00040 
00041 public import mango.cache.model.IPayload;
00042 
00043 /******************************************************************************
00044 
00045         Base-class for entries placed into both the cache and cluster
00046         framework
00047 
00048 ******************************************************************************/
00049 
00050 class Payload : IPayload
00051 {
00052         private ulong time;
00053 
00054         /**********************************************************************
00055 
00056                 Destroy this payload. Often used to return instances to a
00057                 freelist, or otherwise release resources.
00058 
00059         **********************************************************************/
00060 
00061         void destroy ()
00062         {
00063         }
00064 
00065         /***********************************************************************
00066 
00067                 Return the timestamp associated with this payload
00068 
00069         ***********************************************************************/
00070 
00071         long getTime ()
00072         {
00073                 return time;
00074         }
00075 
00076         /***********************************************************************
00077 
00078                 Set the timestamp of this payload
00079 
00080         ***********************************************************************/
00081 
00082         void setTime (long time)
00083         {
00084                 this.time = time;
00085         }
00086 
00087         /**********************************************************************
00088         
00089                 Recover the timestamp from the provided reader
00090 
00091         **********************************************************************/
00092 
00093         void read (IReader reader)
00094         {
00095                 reader.get (time);
00096         }
00097 
00098         /**********************************************************************
00099 
00100                 Emit our timestamp to the provided writer
00101 
00102         **********************************************************************/
00103 
00104         void write (IWriter writer)
00105         {
00106                 writer.put (time);
00107         }
00108 
00109         /***********************************************************************
00110 
00111                 Create a new instance of a payload, and populate it via
00112                 read() using the specified reader
00113 
00114         ***********************************************************************/
00115 
00116         Object create (IReader reader)
00117         {
00118                 Payload r = cast(Payload) create ();
00119                 r.read (reader);
00120                 return r;
00121         }
00122 
00123         /**********************************************************************
00124 
00125                 Overridable create method that simply instantiates a 
00126                 new instance. May be used to allocate subclassses from 
00127                 a freelist
00128 
00129         **********************************************************************/
00130 
00131         Object create ()
00132         {
00133                 return new Payload;
00134         }
00135 
00136         /**********************************************************************
00137 
00138                 Return the guid for this payload. This should be unique
00139                 per payload class, if said class is used in conjunction
00140                 with the clustering facilities. Inspected by the Pickle
00141                 utilitiy classes.
00142                 
00143         **********************************************************************/
00144 
00145         char[] getGuid ()
00146         {
00147                 return this.classinfo.name;
00148         }
00149 }
00150 
00151 

Generated on Mon Nov 14 10:59:39 2005 for Mango by  doxygen 1.4.0