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

IDSSGeneralCacheInfo Interface Reference

List of all members.

Detailed Description

The properties for IDSSGeneralCacheInfo are:.


Public Member Functions

HRESULT CacheCheckCount ([out, retval] Int32 *pVal)
 The number of times that cache lookup hash table is checked for a cache since the server start-up this time.
HRESULT CacheHitCount ([out, retval] Int32 *pVal)
 The number of times that a cache is hit since the server start-up this time.
HRESULT CacheTableBucketCount ([out, retval] Int32 *pVal)
 The number of buckets in the cache lookup hash table.
HRESULT CacheTableBucketPerLock ([out, retval] Int32 *pVal)
 The number of buckets a lock locks.
HRESULT CacheUpdateCount ([out, retval] Int32 *pVal)
 The number of times that a cache is updated/created since the server start up this time.
HRESULT FileCachePath ([out, retval] BSTR *pVal)
 The path where the caches are stored.
HRESULT HistoricCacheCheckCount ([out, retval] Int32 *pVal)
 The number of times that cache lookup hash table is checked for a cache so far in history.
HRESULT HistoricCacheHitCount ([out, retval] Int32 *pVal)
 The number of times so far in history that a cache is hit.
HRESULT HistoricCacheUpdateCount ([out, retval] Int32 *pVal)
 The number of times so far in history that a cache is updated/created.
HRESULT MaxCacheCount ([out, retval] Int32 *pVal)
 Maximum number of caches (in memory or on disk) allowed in the cache pool hash table.
HRESULT MaxMemoryConsumption ([out, retval] Int32 *pVal)
 Maximum size of memory allocated for caches in memory.
HRESULT SwapPolicy ([out, retval] EnumDSSCacheSwapPolicy *pVal)
 Swap policy used for cache.
HRESULT TotalCacheCount ([out, retval] Int32 *pVal)
 The actual number of caches (in memory or on disk) in the cache pool hash table.
HRESULT TotalMemoryConsumption ([out, retval] Int32 *pVal)
 The size of memory used by all the in-memory caches.

Member Function Documentation

HRESULT IDSSGeneralCacheInfo::CacheCheckCount (  [out, retval] Int32 *  pVal  ) 
 

The number of times that cache lookup hash table is checked for a cache since the server start-up this time.

Parameters:
pVal The pointer to the value of the number of times that cache lookup hash table is checked for a cache since the server is started up this time.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::CacheHitCount (  [out, retval] Int32 *  pVal  ) 
 

The number of times that a cache is hit since the server start-up this time.

Parameters:
pVal The pointer to the value of the number of times that a cache is hit since the server is started up this time.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::CacheTableBucketCount (  [out, retval] Int32 *  pVal  ) 
 

The number of buckets in the cache lookup hash table.

Parameters:
pVal The pointer to the value of the number of buckets in the cache lookup hash table.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::CacheTableBucketPerLock (  [out, retval] Int32 *  pVal  ) 
 

The number of buckets a lock locks.

(Not implemented yet.). The number of buckets a lock locks.

Parameters:
pVal The pointer to the value of the number of buckets a lock locks.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::CacheUpdateCount (  [out, retval] Int32 *  pVal  ) 
 

The number of times that a cache is updated/created since the server start up this time.

Parameters:
pVal The pointer to the value of the number of times that a cache is updated/created since the server is started up this time.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::FileCachePath (  [out, retval] BSTR *  pVal  ) 
 

The path where the caches are stored.

Parameters:
pVal The pointer to the string that contains the path where the caches is stored.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::HistoricCacheCheckCount (  [out, retval] Int32 *  pVal  ) 
 

The number of times that cache lookup hash table is checked for a cache so far in history.

Parameters:
pVal The pointer to the value of the number of times that cache lookup hash table is checked for a cache so far in history.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::HistoricCacheHitCount (  [out, retval] Int32 *  pVal  ) 
 

The number of times so far in history that a cache is hit.

Parameters:
pVal The pointer to the value of the number of times a cache is hit so far in history.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::HistoricCacheUpdateCount (  [out, retval] Int32 *  pVal  ) 
 

The number of times so far in history that a cache is updated/created.

Parameters:
pVal The pointer to the value of the number of times that a cache is updated/created so far in history.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::MaxCacheCount (  [out, retval] Int32 *  pVal  ) 
 

Maximum number of caches (in memory or on disk) allowed in the cache pool hash table.

Parameters:
pVal The pointer to the value of the maximum number of caches allowed in the cache pool hash table.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::MaxMemoryConsumption (  [out, retval] Int32 *  pVal  ) 
 

Maximum size of memory allocated for caches in memory.

An estimate in K bytes. Maximum size of memory allocated for in-memory caches. An estimate in K bytes.

Parameters:
pVal The pointer to the value of the maximum size of memory allocated for in-memory caches. An estimate in K bytes.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::SwapPolicy (  [out, retval] EnumDSSCacheSwapPolicy *  pVal  ) 
 

Swap policy used for cache.

When the memory size of in-memory caches reaches the limit and a new cache need to be added, or an existing cache needs to be loaded into memory from disk, we use the swap policy to decide which existing in-memory caches to be swapped out of memory in the case of report caching.
EnumDSSCacheSwapPolicy has the following values:
  • DssCacheSwapPolicyLRU - LRU swap policy(least recently used).
  • DssCacheSwapPolicyLHC - Least hit count cache will be replaced.
Parameters:
pVal The pointer to the value of the swap policy we use to decide which existing in-memory caches to be swapped out of memory.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::TotalCacheCount (  [out, retval] Int32 *  pVal  ) 
 

The actual number of caches (in memory or on disk) in the cache pool hash table.

Parameters:
pVal The pointer to the value of the actual number of caches (in memory or on disk) in the cache pool hash table.
Returns:
Usual COM result code:
  • S_OK

HRESULT IDSSGeneralCacheInfo::TotalMemoryConsumption (  [out, retval] Int32 *  pVal  ) 
 

The size of memory used by all the in-memory caches.

Parameters:
pVal The pointer to the value of the size of memory used by all the in-memory caches.
Returns:
Usual COM result code:
  • S_OK

Copyright © 1996-2018 MicroStrategy Inc. All Rights Reserved.