00001 /* 00002 * Funambol is a mobile platform developed by Funambol, Inc. 00003 * Copyright (C) 2003 - 2007 Funambol, Inc. 00004 * 00005 * This program is free software; you can redistribute it and/or modify it under 00006 * the terms of the GNU Affero General Public License version 3 as published by 00007 * the Free Software Foundation with the addition of the following permission 00008 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED 00009 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 00010 * WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 00011 * 00012 * This program is distributed in the hope that it will be useful, but WITHOUT 00013 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 00014 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 00015 * details. 00016 * 00017 * You should have received a copy of the GNU Affero General Public License 00018 * along with this program; if not, see http://www.gnu.org/licenses or write to 00019 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 00020 * MA 02110-1301 USA. 00021 * 00022 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 00023 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com. 00024 * 00025 * The interactive user interfaces in modified source and object code versions 00026 * of this program must display Appropriate Legal Notices, as required under 00027 * Section 5 of the GNU Affero General Public License version 3. 00028 * 00029 * In accordance with Section 7(b) of the GNU Affero General Public License 00030 * version 3, these Appropriate Legal Notices must retain the display of the 00031 * "Powered by Funambol" logo. If the display of the logo is not reasonably 00032 * feasible for technical reasons, the Appropriate Legal Notices must display 00033 * the words "Powered by Funambol". 00034 */ 00035 00036 00037 #ifndef INCL_DSMEM 00038 #define INCL_DSMEM 00039 /** @cond DEV */ 00040 00041 #include "base/fscapi.h" 00042 #include "base/globalsdef.h" 00043 00044 BEGIN_NAMESPACE 00045 00046 00047 class DSMem { 00048 00049 // ------------------------------------------------------------ Private data 00050 private: 00051 00052 bool sharedMem; 00053 long maxMem ; 00054 long maxID ; 00055 // ---------------------------------------------------------- Protected data 00056 public: 00057 00058 DSMem(); 00059 ~DSMem(); 00060 00061 /** 00062 * Creates a new DSMem object with the given sharedMem, maxMem and maxID 00063 * 00064 * @param sharedMem is true if the datastore uses shared memory 00065 * @param maxMem the maximum memory size for o given datastore 00066 * @param maxID the maximum number of items that can be stored in a given 00067 * datastore 00068 * 00069 */ 00070 DSMem(bool sharedMem, long maxMem, long maxID); 00071 00072 /** 00073 * Sets the memoryShared status 00074 * 00075 * @param sharedMem the new memoryShared status 00076 */ 00077 void setSharedMem(bool sharedMem); 00078 00079 /** 00080 * Gets Boolean shared memory 00081 * 00082 * @return sharedMem the Boolean sharedMem 00083 */ 00084 bool getSharedMem(); 00085 00086 /** 00087 * Gets the maximum memory size in bytes 00088 * 00089 * @return if value is -1 indicates that the property value is unspecified 00090 */ 00091 long getMaxMem(); 00092 00093 /** 00094 * Sets the max memory property 00095 * 00096 * @param maxMem the value of max memory property 00097 * 00098 */ 00099 void setMaxMem(long maxMem); 00100 00101 /** 00102 * Gets the maximum number of items 00103 * 00104 * @return if value is -1 indicates that the property value is unspecified 00105 */ 00106 long getMaxID(); 00107 00108 /** 00109 * Sets the max ID property 00110 * 00111 * @param maxID the value of maxID property 00112 */ 00113 void setMaxID(long maxID); 00114 00115 DSMem* clone(); 00116 }; 00117 00118 00119 END_NAMESPACE 00120 00121 /** @endcond */ 00122 #endif