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 00038 #ifndef INCL_MEM 00039 #define INCL_MEM 00040 /** @cond DEV */ 00041 00042 #include "base/fscapi.h" 00043 #include "syncml/core/Mem.h" 00044 #include "base/globalsdef.h" 00045 00046 BEGIN_NAMESPACE 00047 00048 class Mem { 00049 00050 // ------------------------------------------------------------ Private data 00051 private: 00052 bool sharedMem; 00053 long freeMem ; 00054 long freeID ; 00055 public: 00056 00057 ~Mem(); 00058 00059 /** 00060 * Creates a new Mem object from memory characteristics. 00061 * 00062 * @param sharedMem is the datastore memory shared 00063 * @param freeMem free memory size in bytes (>= 0) 00064 * @param freeID number of available item IDs (>= 0) 00065 * 00066 */ 00067 Mem(bool sharedMem, long freeMem, long freeID); 00068 00069 /** 00070 * Sets the memoryShared status 00071 * 00072 * @param sharedMem the new memoryShared status 00073 */ 00074 void setSharedMem(bool sharedMem); 00075 00076 /** 00077 * Gets the Boolean shared memory property 00078 * 00079 * @return sharedMem the Boolean shared memory property 00080 */ 00081 bool getSharedMem(); 00082 00083 /** 00084 * Returns the freeMem property (in bytes) 00085 * 00086 * @return the freeMem property 00087 * 00088 */ 00089 long getFreeMem(); 00090 00091 /** 00092 * Sets the freeMem property. 00093 * 00094 * @param freeMem the freeMem value (>= 0) 00095 * 00096 */ 00097 00098 void setFreeMem(long freeMem); 00099 00100 /** 00101 * Returns the number of available item IDs (>= 0) 00102 * 00103 * @return the number of available item IDs (>= 0) 00104 * 00105 */ 00106 long getFreeID(); 00107 00108 /** 00109 * Sets the freeID property. 00110 * 00111 * @param freeID the freeIDCount value (>= 0) 00112 * 00113 */ 00114 void setFreeID(long freeID); 00115 00116 Mem* clone(); 00117 00118 }; 00119 00120 00121 END_NAMESPACE 00122 00123 /** @endcond */ 00124 #endif