osbcache.h

sloedgy open sip stack source code

 /****************License************************************************
  *
  * Copyright 2000-2003.  ScanSoft, Inc.    
  *
  * Use of this software is subject to notices and obligations set forth 
  * in the SpeechWorks Public License - Software Version 1.2 which is 
  * included with this software. 
  *
  * ScanSoft is a registered trademark of ScanSoft, Inc., and OpenSpeech, 
  * SpeechWorks and the SpeechWorks logo are registered trademarks or 
  * trademarks of SpeechWorks International, Inc. in the United States 
  * and other countries.
  *
  ***********************************************************************/
 

 #ifndef _OSBCACHE_H
 #define _OSBCACHE_H
 
#include <vxibuildopts.h>
#if P_VXI

 #include "vxi/VXIcache.h"                  /* For VXIcache base interface */
 #include "vxi/VXIlog.h"                    /* For VXIlog interface */
 
 #include "vxi/VXIheaderPrefix.h"
 #ifdef OSBCACHE_EXPORTS
 #define OSBCACHE_API SYMBOL_EXPORT_DECL
 #else
 #define OSBCACHE_API SYMBOL_IMPORT_DECL
 #endif
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
  * @name OSBcache
  * @memo OSBcache implementation of VXIcache
  * @doc
  * OSBcache interface, and implementation of the VXIcache abstract
  * interface which permits writing arbitrary data into the cache with
  * a client supplied key name, then retrieving that data from the
  * cache one or more times by reading against that key name. <p>
  *
  * Normally the cache implementation can choose to discard the data
  * between the write and the read when necessary (due to running out
  * of cache space, etc.), but it is also possible for clients to lock
  * data in the cache to support built-in grammars and other data that
  * is explicitly provisioned by system administrators and thus must
  * not be removed unless by explicit system administrator command. <p>
  *
  * See VXIcache.h for additional details.
  *
  * This implementation currently does NOT factor in
  * CACHE_CREATION_COST when determining how to clean up the cache, and
  * all caching is done on disk resulting in CACHE_FLAG_LOCK_MEMORY
  * being treated as CACHE_FLAG_LOCK. In addition,
  * CACHE_FLAG_NONBLOCKING_IO is ignored, disk I/O is done in a
  * blocking manner (usually undetectable by clients since local disks
  * are used). Long key names are handled using MD5 digests as described
  * as a potential implementation choice in VXIcache.h.
  *
  * There is one cache interface per thread/line.  
  */
 
   /*@{*/
 
 
 /**
  * Global platform initialization of OSBcache
  *
  * @param log              VXI Logging interface used for error/diagnostic 
  *                         logging, only used for the duration of this 
  *                         function call
  * @param cacheDir         Cache directory name
  * @param cacheSizeMB      Maximum size of the data in the cache directory,
  *                         in megabytes
  * @param entryMaxSizeMB   Maximum size of any individual cache entry, in
  *                         megabytes
  * @param entryExpTimeSec  Maximum amount of time any individual cache entry
  *                         will remain in the cache, in seconds
  * @param unlockEntries    TRUE to unlock locked entries on startup (from
  *                         using CACHE_FLAG_LOCK and CACHE_FLAG_LOCK_MEMORY),
  *                         FALSE to leave them locked. In most cases it is
  *                         best to pass TRUE with the platform re-adding
  *                         locked entries at startup in order to avoid
  *                         having obsolete locked entries fill up the cache.
  *                         However, for some multi-process oriented
  *                         integrations it may be necessary to pass FALSE
  *                         and do this cleanup in some other way.
  *
  * @result VXIcache_RESULT_SUCCESS on success
  */
 OSBCACHE_API VXIcacheResult OSBcacheInit (VXIlogInterface  *log,
 					  const VXIunsigned diagLogBase,
 					  const VXIchar    *cacheDir,
 					  const int         cacheSizeMB,
 					  const int         entryMaxSizeMB,
 					  const int         entryExpTimeSec,
 					  VXIbool           unlockEntries);
 
 /**
  * Global platform shutdown of OSBcache
  *
  * @param log    VXI Logging interface used for error/diagnostic logging,
  *               only used for the duration of this function call
  *
  * @result VXIcache_RESULT_SUCCESS on success
  */
 OSBCACHE_API VXIcacheResult OSBcacheShutDown (VXIlogInterface  *log);
 
 /**
  * Create a new cache service handle
  *
  * @param log            VXI Logging interface used for error/diagnostic 
  *                       logging, must remain a valid pointer throughout the 
  *                       lifetime of the resource (until 
  *                       OSBcacheDestroyResource( ) is called)
  *
  * @result VXIcache_RESULT_SUCCESS on success 
  */
 OSBCACHE_API 
 VXIcacheResult OSBcacheCreateResource (VXIlogInterface     *log,
 				       VXIcacheInterface   **cache);
   
 /**
  * Destroy the interface and free internal resources. Once this is
  *  called, the logging interface passed to OSBcacheCreateResource( ) 
  *  may be released as well.
  *
  * @result VXIcache_RESULT_SUCCESS on success 
  */
 OSBCACHE_API 
 VXIcacheResult OSBcacheDestroyResource (VXIcacheInterface **cache);
 
   /*@}*/
 
 #ifdef __cplusplus
 }
 #endif
 
 #include "vxi/VXIheaderSuffix.h"
 
#endif

 #endif  /* include guard */