src/client-api/src/include/common/syncml/core/Mem.h

   1 /*
   2  * Funambol is a mobile platform developed by Funambol, Inc.
   3  * Copyright (C) 2003 - 2007 Funambol, Inc.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under
   6  * the terms of the GNU Affero General Public License version 3 as published by
   7  * the Free Software Foundation with the addition of the following permission
   8  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
   9  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE
  10  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program; if not, see http://www.gnu.org/licenses or write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  20  * MA 02110-1301 USA.
  21  *
  22  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite
  23  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
  24  *
  25  * The interactive user interfaces in modified source and object code versions
  26  * of this program must display Appropriate Legal Notices, as required under
  27  * Section 5 of the GNU Affero General Public License version 3.
  28  *
  29  * In accordance with Section 7(b) of the GNU Affero General Public License
  30  * version 3, these Appropriate Legal Notices must retain the display of the
  31  * "Powered by Funambol" logo. If the display of the logo is not reasonably
  32  * feasible for technical reasons, the Appropriate Legal Notices must display
  33  * the words "Powered by Funambol".
  34  */
  35
  36
  37
  38 #ifndef INCL_MEM
  39 #define INCL_MEM
  40 /** @cond DEV */
  41
  42 #include "base/fscapi.h"
  43 #include "syncml/core/Mem.h"
  44 #include "base/globalsdef.h"
  45
  46 BEGIN_NAMESPACE
  47
  48 class Mem {
  49
  50      // ------------------------------------------------------------ Private data
  51     private:
  52         bool    sharedMem;
  53         long    freeMem  ;
  54         long    freeID   ;
  55     public:
  56
  57         ~Mem();
  58
  59         /**
  60          * Creates a new Mem object from memory characteristics.
  61          *
  62          * @param sharedMem is the datastore memory shared
  63          * @param freeMem free memory size in bytes (>= 0)
  64          * @param freeID number of available item IDs (>= 0)
  65          *
  66          */
  67         Mem(bool sharedMem, long freeMem, long freeID);
  68
  69          /**
  70          * Returns the memoryShared status
  71          *
  72          * @return <i>true</i> if the datastore memory is shared, <i>false</i> otherwise
  73          *
  74          */
  75         bool isSharedMem();
  76
  77         /**
  78          * Sets the memoryShared status
  79          *
  80          * @param sharedMem the new memoryShared status
  81          */
  82         void setSharedMem(bool sharedMem);
  83
  84         /**
  85          * Gets the Boolean shared memory property
  86          *
  87          * @return sharedMem the Boolean shared memory property
  88          */
  89         bool getSharedMem();
  90
  91         /**
  92          * Returns the freeMem property (in bytes)
  93          *
  94          * @return the freeMem property
  95          *
  96          */
  97         long getFreeMem();
  98
  99         /**
 100          * Sets the freeMem property.
 101          *
 102          * @param freeMem the freeMem value (>= 0)
 103          *
 104          */
 105
 106         void setFreeMem(long freeMem);
 107
 108         /**
 109          * Returns the number of available item IDs (>= 0)
 110          *
 111          * @return the number of available item IDs (>= 0)
 112          *
 113          */
 114         long getFreeID();
 115
 116         /**
 117          * Sets the freeID property.
 118          *
 119          * @param freeID the freeIDCount value (>= 0)
 120          *
 121          */
 122         void setFreeID(long freeID);
 123
 124         Mem* clone();
 125
 126 };
 127
 128
 129 END_NAMESPACE
 130
 131 /** @endcond */
 132 #endif