netcache_api.hpp File Reference

NetCache client specs. More...

#include "netschedule_api.hpp"
#include "netcache_admin.hpp"
#include "netcache_api_expt.hpp"
#include "netcache_key.hpp"
#include "named_parameters.hpp"
#include <util/simple_buffer.hpp>
#include <corelib/plugin_manager.hpp>
#include <corelib/blob_storage.hpp>

Include dependency graph for netcache_api.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Go to the SVN repository for this file.

Classes
class	CNetCacheAPI
	Client API for NetCache server. More...
class	CBlobStorage_NetCache
	CBlobStorage_NetCache – NetCache-based implementation of IBlobStorage. More...

Macros
#define	nc_blob_ttl   CNetCacheAPI::TBlobTTL()
	Blob life span in seconds. More...
#define	nc_caching_mode   CNetCacheAPI::TCachingMode()
	Caching mode. More...
#define	nc_mirroring_mode   CNetCacheAPI::TMirroringMode()
	Mirroring mode. More...
#define	nc_server_check   CNetCacheAPI::TServerCheck()
	For blob readers: whether to check if the primary server that stores the blob is still in service. More...
#define	nc_server_check_hint   CNetCacheAPI::TServerCheckHint()
	For blob writers: whether to advise the readers to check if the primary server that stores the blob is still in service. More...
#define	nc_blob_password   CNetCacheAPI::TBlobPassword()
	Blob password. More...
#define	nc_server_to_use   CNetCacheAPI::TServerToUse()
	The server to use for the operation. More...
#define	nc_server_last_used   CNetCacheAPI::TServerLastUsedPtr()
	Pointer to a variable for saving the CNetServer that was last used. More...
#define	nc_max_age   CNetCacheAPI::TMaxBlobAge()
	Do not read the blob if its age is greater than the specified value. More...
#define	nc_actual_age   CNetCacheAPI::TActualBlobAgePtr()
	A pointer to an unsigned variable where the actual age of the blob must be stored. More...
#define	nc_use_compound_id   CNetCacheAPI::TUseCompoundID()
	Whether to return NetCache keys in CompoundID format. More...
#define	nc_try_all_servers   CNetCacheAPI::TTryAllServers()
	Whether to run a request through all NetCache servers in the ICache service in an attempt to find the blob. More...
#define	nc_cache_name   CNetCacheAPI::TCacheName()
	In ICache mode, override the name of the cache specified in the CNetICacheClient constructor. More...

Functions
	NCBI_DECLARE_INTERFACE_VERSION (SNetCacheAPIImpl, "xnetcacheapi", 1, 1, 0)
void	NCBI_EntryPoint_xnetcacheapi (CPluginManager< SNetCacheAPIImpl >::TDriverInfoList &info_list, CPluginManager< SNetCacheAPIImpl >::EEntryPointRequest method)

Variables
const char *const	kNetCacheAPIDriverName

Detailed Description

NetCache client specs.

Definition in file netcache_api.hpp.