Buffer.h

Go to the documentation of this file.

/******************************************************************************
 * Project:  libspatialindex - A C++ library for spatial indexing
 * Author:   Marios Hadjieleftheriou, [email protected]
 ******************************************************************************
 * Copyright (c) 2002, Marios Hadjieleftheriou
 *
 * All rights reserved.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
******************************************************************************/
 
#pragma once
 
#include <cstring>
 
using namespace SpatialIndex;
using namespace SpatialIndex::StorageManager;
 
namespace SpatialIndex
{
        namespace StorageManager
        {
                class Buffer : public IBuffer
                {
                public:
                        Buffer(IStorageManager& sm, Tools::PropertySet& ps);
                                // String                   Value     Description
                                // ----------------------------------------------
                                // Capacity             VT_ULONG        Buffer maximum capacity.
                                // WriteThrough VT_BOOL Enable or disable write through policy.
 
                        virtual ~Buffer();
 
                        virtual void flush();
                        virtual void loadByteArray(const id_type page, uint32_t& len, byte** data);
                        virtual void storeByteArray(id_type& page, const uint32_t len, const byte* const data);
                        virtual void deleteByteArray(const id_type page);
 
                        virtual void clear();
                        virtual uint64_t getHits();
 
                protected:
                        class Entry
                        {
                        public:
                                Entry(uint32_t l, const byte* const d) : m_pData(0), m_length(l), m_bDirty(false)
                                {
                                        m_pData = new byte[m_length];
                                        memcpy(m_pData, d, m_length);
                                }
 
                                ~Entry() { delete[] m_pData; }
 
                                byte* m_pData;
                                uint32_t m_length;
                                bool m_bDirty;
                        }; // Entry
 
                        virtual void addEntry(id_type page, Entry* pEntry) = 0;
                        virtual void removeEntry() = 0;
 
                        uint32_t m_capacity;
                        bool m_bWriteThrough;
                        IStorageManager* m_pStorageManager;
                        std::map<id_type, Entry*> m_buffer;
                        uint64_t m_u64Hits;
                }; // Buffer
        }
}