ScaleOut C++ Native Client API  5.1
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Pages
sosscli::NamedCache::DefaultCachePolicy Class Reference

The DefaultCachePolicy class provides defines default behaviors and policies for named cache operations. More...

#include <named_cache.h>

Public Member Functions

 DefaultCachePolicy ()
 Constructor.
 
virtual ~DefaultCachePolicy ()
 Destructor.
 
boost::posix_time::time_duration timeout () const
 Gets the default lifetime of objects in a named cache.
 
void set_timeout (boost::posix_time::time_duration timeout)
 Sets the default lifetime of objects in a named cache.
 
ObjectPolicy::TimeoutType timeout_type () const
 Gets the default timeout time (absolute, sliding) for objects in a named cache.
 
void set_timeout_type (ObjectPolicy::TimeoutType timeout_type)
 Sets the default timeout time (absolute, sliding) for objects in a named cache.
 
ObjectPolicy::PreemptionPriority preemption_priority () const
 Gets the default preemption priority for objects in a named cache.
 
void set_preemption_priority (ObjectPolicy::PreemptionPriority preemption_priority)
 Sets the default preemption priority for objects in a named cache.
 
bool allow_push_repl () const
 Gets whether a named cache's objects are subject to GeoServer "push" replication.
 
void set_allow_push_repl (bool allow_push_repl)
 Sets whether a named cache's objects are subject to GeoServer "push" replication.
 
bool use_client_cache ()
 Returns a boolean indicating whether the named cache operations will maintain and return up-to-date instances of the objects in the client cache.
 
void set_use_client_cache (bool use_client_cache)
 Sets whether the named cache operations should maintain and return up-to-date instances of the objects in the client cache.
 
bool throw_on_error () const
 Returns a boolean indicating whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error. More...
 
void set_throw_on_error (bool throw_on_error)
 Sets whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error. More...
 
int32_t max_lock_retry_count () const
 Gets the default number of retries that a named cache should perform when polling to acquire an exclusive lock on an object.
 
void set_max_lock_retry_count (int32_t max_lock_retry_count)
 Sets the default number of retries that a named cache should perform when polling to acquire an exclusive lock on an object.
 
int32_t lock_retry_interval_ms () const
 Gets the amount of time (in milliseconds) between polling attempts to acquire an exclusive lock on a cached object.
 
void set_lock_retry_interval_ms (int32_t lock_retry_interval_ms)
 Sets the amount of time (in milliseconds) between polling attempts to acquire an exclusive lock on a cached object.
 
int32_t max_read_pending_attempts () const
 Gets the number of read attempts made when waiting for a one-time object creation callback to insert a missing object into the store.
 
void set_max_read_pending_attempts (int32_t max_read_pending_attempts)
 Sets the number of read attempts made when waiting for a one-time object creation callback to insert a missing object into the store.
 
int32_t read_pending_retry_interval_ms () const
 Gets the amount of time (in milliseconds) between read retries when waiting for a one-time object creation callback to insert a missing object into the store.
 
void set_read_pending_retry_interval_ms (int32_t read_pending_retry_interval_ms)
 Sets the amount of time (in milliseconds) between read retries when waiting for a one-time object creation callback to insert a missing object into the store.
 

Friends

template<typename T >
class TypedNamedCache
 

Detailed Description

The DefaultCachePolicy class provides defines default behaviors and policies for named cache operations.

Behaviors defined in the DefaultCachePolicy can be overridden on a call-by-call basis using option and policy classes that are passed as arguments to named cache methods

See Also
ObjectPolicy
GetOptions
LockOptions

Member Function Documentation

void sosscli::NamedCache::DefaultCachePolicy::set_throw_on_error ( bool  throw_on_error)
inline

Sets whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error.

If false, error code information will be available in the returned GetResult, PutResult, or LockResult.

bool sosscli::NamedCache::DefaultCachePolicy::throw_on_error ( ) const
inline

Returns a boolean indicating whether a method will throw an exception derived from sosscli::exceptions::StateServerException if the ScaleOut StateServer service returns an error.

If false, error code information will be available in the returned GetResult, PutResult, or LockResult.


The documentation for this class was generated from the following file: