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

PickleWriter.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file PickleWriter.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 
00027                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
00028 
00029 
00030         @version        Initial version, April 2004      
00031         @author         Kris
00032 
00033 
00034 *******************************************************************************/
00035 
00036 module mango.io.PickleWriter;
00037 
00038 private import  mango.io.EndianWriter;
00039 
00040 private import  mango.io.model.IPickle;
00041 
00042 
00043 /*******************************************************************************
00044 
00045         Serialize Objects via an EndianWriter. All Objects are written in
00046         Network-order such that they may cross machine boundaries.
00047 
00048         See PickleReader for an example of how to use this.
00049 
00050 *******************************************************************************/
00051 
00052 version (BigEndian)
00053          alias Writer SuperClass;
00054       else
00055          alias EndianWriter SuperClass;
00056 
00057 class PickleWriter : SuperClass
00058 {
00059         /***********************************************************************
00060         
00061                 Construct a PickleWriter upon the given buffer. As
00062                 Objects are serialized, their content is written to this
00063                 buffer. The buffer content is then typically flushed to 
00064                 some external conduit, such as a file or socket.
00065 
00066                 Note that serialized data is always in Network order.
00067 
00068         ***********************************************************************/
00069         
00070         this (IBuffer buffer)
00071         {
00072                 super (buffer);
00073         }
00074 
00075         /***********************************************************************
00076         
00077                 Serialize an Object. Objects are written in Network-order, 
00078                 and are prefixed by the guid exposed via the IPickle
00079                 interface. This guid is used to identify the appropriate
00080                 factory when reconstructing the instance. 
00081 
00082         ***********************************************************************/
00083 
00084         PickleWriter freeze (IPickle object)
00085         {
00086                 put (object.getGuid);
00087                 object.write (this);
00088                 return this;
00089         }
00090 }
00091 

Generated on Sun Nov 7 19:06:52 2004 for Mango by doxygen 1.3.6