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

Generated on Sat Apr 9 20:11:27 2005 for Mango by doxygen 1.3.6