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

The PmicliInvokeResult class represents the result of a pmicli_invoke operation and provides a smart pointer to the results object. More...

#include <pmicli_invoke_result.h>

Public Member Functions

 PmicliInvokeResult (const int32_t return_code, boost::shared_ptr< std::vector< uint8_t > > object_ptr, boost::shared_ptr< std::vector< sosscli::exceptions::PmiCliUserExceptionCode > > exceptions_ptr, const unsigned int num_successful, const unsigned int num_failed)
 Constructor (intended for use by the C++ API, not client applications).
 
virtual ~PmicliInvokeResult ()
 Destructor.
 
boost::shared_ptr< std::vector
< uint8_t > > 
object_ptr ()
 Returns a shared pointer (Boost::shared_ptr) to the results object. More...
 
boost::shared_ptr< std::vector
< sosscli::exceptions::PmiCliUserExceptionCode > > 
exceptions_ptr ()
 Returns a shared pointer (Boost::shared_ptr) to the results object. More...
 
int32_t return_code () const
 Gets the code returned from the ScaleOut StateServer service, where negative values indicate that an error occurred.
 
unsigned int num_successful () const
 Gets the number of objects with successful results that are part of the final results.
 
unsigned int num_failed () const
 Gets the number of objects that failed either in evaluating or in merging their results.
 

Detailed Description

The PmicliInvokeResult class represents the result of a pmicli_invoke operation and provides a smart pointer to the results object.

Member Function Documentation

boost::shared_ptr< std::vector<sosscli::exceptions::PmiCliUserExceptionCode> > sosscli::PmicliInvokeResult::exceptions_ptr ( )
inline

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

See Also
http://www.boost.org/libs/smart_ptr/shared_ptr.htm
boost::shared_ptr< std::vector<uint8_t> > sosscli::PmicliInvokeResult::object_ptr ( )
inline

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

See Also
http://www.boost.org/libs/smart_ptr/shared_ptr.htm

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