00001 /******************************************************************************* 00002 00003 @file IBitBucket.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 of the source. 00029 00030 00031 @version Initial version, June 2004 00032 @author Kris 00033 00034 00035 *******************************************************************************/ 00036 00037 00038 module mango.io.model.IBitBucket; 00039 00040 /****************************************************************************** 00041 00042 IBitBucket implements a simple mechanism to store and recover a 00043 large quantity of data for the duration of the hosting process. 00044 It is intended to act as a local-cache for a remote data-source, 00045 or as a spillover area for large in-memory cache instances. 00046 00047 Note that any and all stored data is rendered invalid the moment 00048 an IBucket object is garbage-collected. 00049 00050 All index keys must be unique. Writing to an IBitBucket with an 00051 existing key will overwrite any previous content. 00052 00053 ******************************************************************************/ 00054 00055 interface IBitBucket 00056 { 00057 /********************************************************************** 00058 00059 Return the record-size in use for this IBitBucket 00060 00061 **********************************************************************/ 00062 00063 int getBufferSize (); 00064 00065 /********************************************************************** 00066 00067 Return the currently populated size of this IBitBucket 00068 00069 **********************************************************************/ 00070 00071 long length (); 00072 00073 /********************************************************************** 00074 00075 Return the serialized data for the provided key. Returns 00076 null if the key was not found. 00077 00078 **********************************************************************/ 00079 00080 void[] get (char[] key); 00081 00082 /********************************************************************** 00083 00084 Remove the provided key from this IBitBucket. 00085 00086 **********************************************************************/ 00087 00088 void remove (char[] key); 00089 00090 /********************************************************************** 00091 00092 Write a serialized block of data, and associate it with 00093 the provided key. All keys must be unique, and it is the 00094 responsibility of the programmer to ensure this. Reusing 00095 an existing key will overwrite previous data. 00096 00097 **********************************************************************/ 00098 00099 void put (char[] key, void[] data); 00100 } 00101 00102