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

IPickle.d

Go to the documentation of this file.
00001 /*******************************************************************************
00002 
00003         @file IPickle.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, March 2004      
00034         @author         Kris
00035 
00036 
00037 *******************************************************************************/
00038 
00039 module mango.io.model.IPickle;
00040 
00041 public import mango.io.model.IReader,
00042               mango.io.model.IWriter;
00043 
00044 /*******************************************************************************
00045 
00046         Interface for all serializable classes. Such classes are intended
00047         to be transported over a network, or be frozen in a file for later
00048         reconstruction. 
00049 
00050 *******************************************************************************/
00051 
00052 interface IPickle : IWritable, IReadable
00053 {
00054         /***********************************************************************
00055         
00056                 Identify this serializable class via a char[]. This should
00057                 be (per class) unique within the domain. Use version numbers 
00058                 or similar mechanism to isolate different implementations of
00059                 the same class.
00060 
00061         ***********************************************************************/
00062 
00063         char[] getGuid ();
00064 }
00065 
00066 
00067 /*******************************************************************************
00068 
00069         Interface for all deserializable classes. Such classes either 
00070         implement the full concrete class instance or they act as a
00071         proxy of sorts, creating the true instance only when called 
00072         upon to do so. An IPickleProxy could perhaps take alternative 
00073         action when called upon to create an "old" or "unsupported" 
00074         class guid. The default behaviour is to throw an exception
00075         when an unknown guid is seen.
00076 
00077 *******************************************************************************/
00078 
00079 interface IPickleFactory
00080 {
00081         /***********************************************************************
00082         
00083                 Identify this serializable class via a char[]. This should
00084                 be (per class) unique within the domain. Use version numbers 
00085                 or similar mechanism to isolate different implementations of
00086                 the same class.
00087 
00088         ***********************************************************************/
00089 
00090         char[] getGuid ();
00091 
00092         /***********************************************************************
00093         
00094                 This defines the factory method. Each IPickleProxy object
00095                 provides a factory for creating a deserialized instance.
00096                 The factory is registered along with the appropriate guid.
00097 
00098         ***********************************************************************/
00099 
00100         Object create (IReader reader);
00101 }
00102 

Generated on Sun Mar 6 00:30:57 2005 for Mango by doxygen 1.3.6