#include <VXIcache.h>
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.
Public Attributes | |
VXIint32(* | GetVersion )(void) |
Get the VXI interface version implemented. | |
const VXIchar *(* | GetImplementationName )(void) |
Get the name of the implementation. | |
VXIcacheResult(* | Open )(struct VXIcacheInterface *pThis, const VXIchar *moduleName, const VXIchar *key, VXIcacheOpenMode mode, VXIint32 flags, const VXIMap *properties, VXIMap *streamInfo, VXIcacheStream **stream) |
Open a stream for reading or writing given a wide character key. | |
VXIcacheResult(* | Close )(struct VXIcacheInterface *pThis, VXIcacheStream **stream) |
Close a previously opened stream. | |
VXIcacheResult(* | Unlock )(struct VXIcacheInterface *pThis, const VXIchar *key) |
Unlock an entry that was previously locked into the cache given a wide character key. | |
VXIcacheResult(* | Read )(struct VXIcacheInterface *pThis, VXIbyte *buffer, VXIulong buflen, VXIulong *nread, VXIcacheStream *stream) |
Read from a stream. | |
VXIcacheResult(* | Write )(struct VXIcacheInterface *pThis, const VXIbyte *buffer, VXIulong buflen, VXIulong *nwritten, VXIcacheStream *stream) |
Write to a stream. | |
VXIcacheResult(* | OpenEx )(struct VXIcacheInterface *pThis, const VXIchar *moduleName, const VXIbyte *key, VXIulong keySizeBytes, VXIcacheOpenMode mode, VXIint32 flags, const VXIMap *properties, VXIMap *streamInfo, VXIcacheStream **stream) |
Open a stream for reading or writing given a binary key. | |
VXIcacheResult(* | CloseEx )(struct VXIcacheInterface *pThis, VXIbool keepEntry, VXIcacheStream **stream) |
Close a previously opened stream. | |
VXIcacheResult(* | UnlockEx )(struct VXIcacheInterface *pThis, const VXIbyte *key, VXIulong keySizeBytes) |
Unlock an entry that was previously locked into the cache given a binary key. |
|
Close a previously opened stream. NOTE: CloseEx( ) is the same but supports invalidating the entry Close a previously opened stream. If Close is called on a NULL stream or a previously closed stream an error will be returned
|
|
Close a previously opened stream. NOTE: Same as Close( ) but supports invalidating the entry. This is only available as of version 1.1 of the VXIcacheInterface, use CACHE_CLOSEEX_SUPPORTED( ) to determine availability. Close a previously opened stream. If Close is called on a NULL stream or a previously closed stream an error will be returned
|
|
Get the name of the implementation.
|
|
Get the VXI interface version implemented.
|
|
Open a stream for reading or writing given a wide character key. NOTE: OpenEx( ) is the same but supports binary keys If the cache entry is currently in use and a stream cannot be returned because this use locks the entry, Open should return VXIcache_RESULT_ENTRY_LOCKED. The behavior of opening a cache entry for reading during a write operation is implementation defined.
|
|
Open a stream for reading or writing given a binary key. NOTE: Same as Open( ) but supports binary keys. This is only available as of version 1.1 of the VXIcacheInterface, use CACHE_OPENEX_SUPPORTED( ) to determine availability. If the cache entry is currently in use and a stream cannot be returned because this use locks the entry, Open should return VXIcache_RESULT_ENTRY_LOCKED. The behavior of opening a cache entry for reading during a write operation is implementation defined.
|
|
Read from a stream. This may or not block, as determined by the flags used when opening the stream. When in non-blocking mode, partial buffers may be returned instead of blocking, or an VXIcache_RESULT_WOULD_BLOCK error is returned if no data is available at all.
|
|
Unlock an entry that was previously locked into the cache given a wide character key. NOTE: UnlockEx( ) is the same but supports binary keys This releases a cache lock on the indicated data. Note that it is up to the implementation to decide when to flush the data from the cache, it may choose to do so immediately or may do so at a later time.
|
|
Unlock an entry that was previously locked into the cache given a binary key. NOTE: Same as Unlock( ) but supports binary keys. This is only available as of version 1.1 of the VXIcacheInterface, use CACHE_UNLOCKEX_SUPPORTED( ) to determine availability. This releases a cache lock on the indicated data. Note that it is up to the implementation to decide when to flush the data from the cache, it may choose to do so immediately or may do so at a later time.
|
|
Write to a stream. This may or not block, as determined by the flags used when opening the stream. When in non-blocking mode, partial writes may occur instead of blocking, or an VXIcache_RESULT_WOULD_BLOCK error is returned if no data could be written at all.
|