Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

VXIcache.h File Reference

#include "VXIvalue.h"
#include "VXIheaderPrefix.h"
#include "VXIheaderSuffix.h"

Cache Flags

Set of flags which control the caching behavior of the data put into the cache.

The Open() call takes bitwise or of cache flags which control the caching behavior of data which is written or read from the cache.

#define CACHE_FLAG_NULL   0x0
 Null flag.
#define CACHE_FLAG_LOCK   0x2
 Never flush from the cache.
#define CACHE_FLAG_LOCK_MEMORY   0x4
 Never flush from memory.
#define CACHE_FLAG_NONBLOCKING_IO   0x8
 Non-blocking reads/writes.

Cache Open Properties

Set of properties that are returned on the Open() of an existing cache entry.

The Open() call returns a VXIMap which contains a set of key/value properties. This set of defines provides the definition of the properties that must be supported by an implementation of Open().

#define CACHE_INFO_FINAL_KEY   L"cache.info.finalKey"
 Final key name used for storing the cache entry.
#define CACHE_INFO_LAST_MODIFIED   L"cache.info.lastModified"
 Last Modifed time.
#define CACHE_INFO_SIZE_BYTES   L"cache.info.sizeBytes"
 Size in bytes.

Defines

#define VXICACHE_API   SYMBOL_IMPORT_DECL
#define CACHE_CREATION_COST   L"cache.creationCost"
#define CACHE_CREATION_COST_DEFAULT   CACHE_CREATION_COST_LOW
 Default cache creation cost.
#define CACHE_OPENEX_SUPPORTED(cacheIntf)   (cacheIntf->GetVersion( ) >= 0x00010001)
#define CACHE_CLOSEEX_SUPPORTED(cacheIntf)   (cacheIntf->GetVersion( ) >= 0x00010001)
#define CACHE_UNLOCKEX_SUPPORTED(cacheIntf)   (cacheIntf->GetVersion( ) >= 0x00010001)
#define CACHE_MODE_READ_CREATE_SUPPORTED(cacheIntf)   (cacheIntf->GetVersion( ) >= 0x00010001)

Typedefs

typedef enum VXIcacheCreationCost VXIcacheCreationCost
 Provides a hint on how much CPU/time went into creating the object being written cache.
typedef enum VXIcacheOpenMode VXIcacheOpenMode
 Mode values for VXIcache::Open( ) Open supports ANSI/ISO C standard I/O open modes.
typedef enum VXIcacheResult VXIcacheResult
 VXIcache return codes.
typedef VXIcacheInterface VXIcacheInterface
 Abstract interface for accessing caching functionality.

Enumerations

enum  VXIcacheCreationCost {
  CACHE_CREATION_COST_EXTREME = 40, CACHE_CREATION_COST_HIGH = 30, CACHE_CREATION_COST_MEDIUM = 20, CACHE_CREATION_COST_LOW = 10,
  CACHE_CREATION_COST_FETCH = 0
}
 Provides a hint on how much CPU/time went into creating the object being written cache. More...
enum  VXIcacheOpenMode { CACHE_MODE_READ = 0x0, CACHE_MODE_WRITE = 0x1, CACHE_MODE_READ_CREATE = 0x2 }
 Mode values for VXIcache::Open( ) Open supports ANSI/ISO C standard I/O open modes. More...
enum  VXIcacheResult {
  VXIcache_RESULT_FATAL_ERROR = -100, VXIcache_RESULT_IO_ERROR = -8, VXIcache_RESULT_OUT_OF_MEMORY = -7, VXIcache_RESULT_SYSTEM_ERROR = -6,
  VXIcache_RESULT_PLATFORM_ERROR = -5, VXIcache_RESULT_BUFFER_TOO_SMALL = -4, VXIcache_RESULT_INVALID_PROP_NAME = -3, VXIcache_RESULT_INVALID_PROP_VALUE = -2,
  VXIcache_RESULT_INVALID_ARGUMENT = -1, VXIcache_RESULT_SUCCESS = 0, VXIcache_RESULT_FAILURE = 1, VXIcache_RESULT_NON_FATAL_ERROR = 2,
  VXIcache_RESULT_NOT_FOUND = 50, VXIcache_RESULT_WOULD_BLOCK = 53, VXIcache_RESULT_END_OF_STREAM = 54, VXIcache_RESULT_EXCEED_MAXSIZE = 55,
  VXIcache_RESULT_ENTRY_LOCKED = 56, VXIcache_RESULT_ENTRY_CREATED = 57, VXIcache_RESULT_UNSUPPORTED = 100
}
 VXIcache return codes. More...


Define Documentation

#define VXICACHE_API   SYMBOL_IMPORT_DECL
 


Generated on Wed Jun 1 12:50:18 2005 for OpenVXI by  doxygen 1.4.2