sosscli::PutOptions Class Reference

The PutOptions class contains options that control client cache behavior of put operations. More...

#include <put_options.h>

Public Member Functions
	PutOptions ()
	Default constructor. Creates a PutOptions object that allows client cache usage.
	PutOptions (bool use_client_cache, bool throw_on_error)
	Constructor. More...
virtual	~PutOptions ()
	Destructor.
bool	use_client_cache () const
	Returns a boolean indicating whether the put operation will insert, or possibly update, an up-to-date instance of the object into the API's client cache. More...
PutOptions &	set_use_client_cache (bool use_client_cache)
	Sets whether the put operation should insert, or possibly update, an up-to-date instance of the object into the API's client cache. More...
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...
PutOptions &	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...

Static Public Attributes
static const PutOptions	CACHE_DEFAULTS
	PutOptions constant that indicates that a put/insert operation should use the cache's default options. More...

Detailed Description

The PutOptions class contains options that control client cache behavior of put operations.

Constructor & Destructor Documentation

sosscli::PutOptions::PutOptions ( bool  use_client_cache, bool  throw_on_error  )

inline

Constructor.

Parameters

use_client_cache	Whether the put operation will insert, or possibly update, an up-to-date instance of the object into the API's client cache.
throw_on_error	Determines 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 PutResult.

Returns

Member Function Documentation

PutOptions& sosscli::PutOptions::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 PutResult.

Parameters

throw_on_error

Determines 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 PutResult.

Returns

*this by reference to allow for chained setter method calls.

PutOptions& sosscli::PutOptions::set_use_client_cache ( bool  use_client_cache)

inline

Sets whether the put operation should insert, or possibly update, an up-to-date instance of the object into the API's client cache.

Parameters

use_client_cache

Whether the put operation will insert, or possibly update, an up-to-date instance of the object into the API's client cache.

Returns

*this by reference to allow for chained setter method calls.

bool sosscli::PutOptions::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 PutResult.

bool sosscli::PutOptions::use_client_cache ( ) const

inline

Returns a boolean indicating whether the put operation will insert, or possibly update, an up-to-date instance of the object into the API's client cache.

Member Data Documentation

const PutOptions sosscli::PutOptions::CACHE_DEFAULTS

static

PutOptions constant that indicates that a put/insert operation should use the cache's default options.

---

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

• include/soss_client/put_options.h