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

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