ScaleOut C++ Native Client API  5.1
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Pages
sosscli::GetResult< T > Class Template Reference

The GetResult class represents the result of a get operation and provides a smart pointer to the retrieved object. More...

#include <get_result.h>

Public Member Functions

 GetResult (LockTicket lock_ticket, int32_t version, int32_t return_code, boost::shared_ptr< T > object_ptr, bool client_cache_hit)
 Constructor (intended for use by the C++ API, not client applications).
 
virtual ~GetResult ()
 Destructor.
 
boost::shared_ptr< T > object_ptr ()
 Returns a shared pointer (Boost::shared_ptr) to the retrieved object. More...
 
int32_t version ()
 Gets the object's version, which can be used for optimistic updates. More...
 
LockTicket lock_ticket ()
 Gets the lock ticket returned by a locking insert or update operation.
 
int32_t return_code ()
 Gets the code returned from the ScaleOut StateServer service, where negative values indicate that an error occurred.
 
bool client_cache_hit ()
 Gets whether the returned object was returned from the local, in-process client cache.
 

Detailed Description

template<typename T>
class sosscli::GetResult< T >

The GetResult class represents the result of a get operation and provides a smart pointer to the retrieved object.

Template Parameters
TThe type of object returned from the get operation.

Member Function Documentation

template<typename T>
boost::shared_ptr<T> sosscli::GetResult< T >::object_ptr ( )
inline

Returns a shared pointer (Boost::shared_ptr) to the retrieved object.

See Also
http://www.boost.org/libs/smart_ptr/shared_ptr.htm
template<typename T>
int32_t sosscli::GetResult< T >::version ( )
inline

Gets the object's version, which can be used for optimistic updates.

See Also
TypedNamedCache::update_optimistic
PutResult::version

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