sosscli::RemoveResult Class Reference

The RemoveResult class represents the result of a remove operation. More...

#include <remove_result.h>

Public Types
enum	RemoveOutcome { Error, ObjectRemoved, ObjectNotFound }
	Enumeration describing the outcome of a remove operation. More...

Public Member Functions
	RemoveResult (int32_t return_code)
	Constructor (intended for use by the C++ API, not client applications).
virtual	~RemoveResult ()
	Destructor.
int32_t	return_code ()
	Gets the code returned from the ScaleOut StateServer service, where negative values indicate that an error occurred.
RemoveOutcome	outcome ()
	Indicates whether the object was removed or whether did not exist prior when the remove call was invoked.

Detailed Description

The RemoveResult class represents the result of a remove operation.

Member Enumeration Documentation

enum sosscli::RemoveResult::RemoveOutcome

Enumeration describing the outcome of a remove operation.

Enumerator
Error	The operation did not succeed due to an error.
ObjectRemoved	The operation succeed and the object was removed.
ObjectNotFound	The object to be removed did not exist in the named cache.

---

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

• include/soss_client/remove_result.h