|
ScaleOut C++ Native Client API
5.1
|
The PmiCliUserExceptionCode class represents a user-generated exception code. More...
#include <pmicli_invoke_exception.h>
Public Types | |
| enum | ExceptionSource { MERGE, EVAL } |
| Enumeration specifying whether the exception originated from an eval or a merge operation. | |
Public Member Functions | |
| PmiCliUserExceptionCode (SOSSPMI_EXCEPTION *psosspmi_exception) | |
| Constructor which accepts a pointer to a low-level C struct for conversion to a C++ object. | |
| PmiCliUserExceptionCode (const SOSSPMI_EXCEPTION &psosspmi_exception) | |
| Constructor which accepts a reference to a low-level C struct for conversion to a C++ object. | |
| virtual | ~PmiCliUserExceptionCode (void) |
| Destructor. | |
| int | return_code () const |
| Gets user-defined return code returned from the callback method. | |
| ExceptionSource | exception_source () const |
| Gets exception's source, which is either MERGE or EVAL. | |
| SossKey | key () const |
| For exceptions originating from an EVAL, gets key of the data object that produced the exception. | |
The PmiCliUserExceptionCode class represents a user-generated exception code.
When a user's eval or merge function returns a non-zero value, that value is stored in this class, and is eventually passed back to the user from the Sosspmi_invoke() function. If the exception code originated from an eval function, the key of the object that was being evaluated is also returned.
