sosscli::PmicliInvokeOptions Class Reference

The PmicliInvokeOptions class contains options that control the behavior of the NamedCache::pmicli_invoke method. More...

#include <pmicli_invoke_options.h>

Public Member Functions
	PmicliInvokeOptions ()
	Default constructor. Creates a PmicliInvokeOptions class that throws exceptions on error with an infinite invocation timeout.
	PmicliInvokeOptions (bool throw_on_error, int32_t invoke_timeout_s)
	Constructor. More...
virtual	~PmicliInvokeOptions ()
	Destructor.
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...
PmicliInvokeOptions &	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	invoke_timeout_s () const
	Gets the amount of time (in milliseconds) between polling attempts to acquire an exclusive lock on a cached object.
PmicliInvokeOptions &	set_invoke_timeout_s (int32_t invoke_timeout_s)
	Sets the amount of time (in milliseconds) between polling attempts to acquire an exclusive lock on a cached object. More...

Static Public Attributes
static const PmicliInvokeOptions	CACHE_DEFAULTS
	PmicliInvokeOptions constant that indicates that a get_metadata operation should use the cache's default options. More...

Detailed Description

The PmicliInvokeOptions class contains options that control the behavior of the NamedCache::pmicli_invoke method.

Constructor & Destructor Documentation

sosscli::PmicliInvokeOptions::PmicliInvokeOptions ( bool  throw_on_error, int32_t  invoke_timeout_s  )

inline

Constructor.

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, or if the registered eval or merge functions return an error. If false, error code information will be available in the returned PmicliInvokeResult.
invoke_timeout_s	Amount of time (in seconds) before invocation times out, or SOSSLIB_INFINITE_TIMEOUT.

Member Function Documentation

PmicliInvokeOptions& sosscli::PmicliInvokeOptions::set_invoke_timeout_s ( int32_t  invoke_timeout_s)

inline

Sets the amount of time (in milliseconds) between polling attempts to acquire an exclusive lock on a cached object.

Parameters

invoke_timeout_s

Amount of time (in seconds) before invocation times out, or SOSSLIB_INFINITE_TIMEOUT.

Returns

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

PmicliInvokeOptions& sosscli::PmicliInvokeOptions::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 PmicliInvokeResult.

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, or if the registered eval or merge functions return an error. If false, error code information will be available in the returned PmicliInvokeResult.

Returns

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

bool sosscli::PmicliInvokeOptions::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 PmicliInvokeResult.

Member Data Documentation

const PmicliInvokeOptions sosscli::PmicliInvokeOptions::CACHE_DEFAULTS

static

PmicliInvokeOptions constant that indicates that a get_metadata operation should use the cache's default options.

---

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

• include/soss_client/pmicli_invoke_options.h