iutil/hiercache.h Source File (Crystal Space 2.0 Public API Reference)

| ## Public API Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

iutil/hiercache.h
Go to the documentation of this file.

    00001 /*
    00002     Copyright (C) 2002 by Jorrit Tyberghein
    00003               (C) 2008 by Frank Richter
    00004
    00005     This library is free software; you can redistribute it and/or
    00006     modify it under the terms of the GNU Library General Public
    00007     License as published by the Free Software Foundation; either
    00008     version 2 of the License, or (at your option) any later version.
    00009
    00010     This library is distributed in the hope that it will be useful,
    00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
    00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00013     Library General Public License for more details.
    00014
    00015     You should have received a copy of the GNU Library General Public
    00016     License along with this library; if not, write to the Free
    00017     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
    00018 */
    00019
    00020 #ifndef __CS_IUTIL_HIERCACHE_H__
    00021 #define __CS_IUTIL_HIERCACHE_H__
    00022
    00023 #include "csutil/ref.h"
    00024 #include "csutil/scf_interface.h"
    00025
    00026 struct iDataBuffer;
    00027
    00041 struct iHierarchicalCache : public virtual iBase
    00042 {
    00043   SCF_INTERFACE(iHierarchicalCache, 1,0,3);
    00044
    00049   virtual bool CacheData (const void* data, size_t size,
    00050     const char* path) = 0;
    00051
    00057   virtual csPtr<iDataBuffer> ReadCache (const char* path) = 0;
    00058
    00063   virtual bool ClearCache (const char* path) = 0;
    00064
    00069   virtual void Flush () = 0;
    00070
    00076   virtual csPtr<iHierarchicalCache> GetRootedCache (const char* base) = 0;
    00077
    00079   virtual csPtr<iStringArray> GetSubItems (const char* path) = 0;
    00080
    00082   virtual iHierarchicalCache* GetTopCache() = 0;
    00083
    00085   virtual bool IsCacheWriteable() const = 0;
    00086 };
    00087
    00088 #endif // __CS_IUTIL_HIERCACHE_H__
    00089