Pivotal GemFire Native C++ Reference  10.1.3
apache::geode::client::UserFunctionExecutionException Class Reference

UserFunctionExecutionException class is used to encapsulate geode sendException in case of Function execution. More...

Inherits apache::geode::client::Serializable.

Public Member Functions

const std::string & getMessage () const
 return as std::string the Exception message returned from geode sendException api. More...
 
const std::string & getName () const
 return as std::string the Exception name returned from geode sendException api. More...
 
virtual size_t objectSize () const
 return the size in bytes of the instance being serialized. More...
 
std::string toString () const override
 Display this object as 'string', which depends on the implementation in the subclasses. More...
 

Static Public Member Functions

template<class _T >
static std::shared_ptr< Serializablecreate (_T value)
 Factory method that creates the Serializable object that matches the type of value. More...
 

Detailed Description

UserFunctionExecutionException class is used to encapsulate geode sendException in case of Function execution.

Member Function Documentation

◆ create()

template<class _T >
static std::shared_ptr<Serializable> apache::geode::client::Serializable::create ( _T  value)
staticinherited

Factory method that creates the Serializable object that matches the type of value.

For user defined derivations of Serializable, the method apache::geode::client::Serializable::create may be overloaded.

◆ getMessage()

const std::string& apache::geode::client::UserFunctionExecutionException::getMessage ( ) const
inline

return as std::string the Exception message returned from geode sendException api.

◆ getName()

const std::string& apache::geode::client::UserFunctionExecutionException::getName ( ) const
inline

return as std::string the Exception name returned from geode sendException api.

◆ objectSize()

virtual size_t apache::geode::client::Serializable::objectSize ( ) const
virtualinherited

return the size in bytes of the instance being serialized.

This is used to determine whether the cache is using up more physical memory than it has been configured to use. The method can return zero if the user does not require the ability to control cache memory utilization. Note that you must implement this only if you use the HeapLRU feature.

Reimplemented in apache::geode::client::PdxInstance, apache::geode::client::CacheableString, apache::geode::client::CacheableEnum, and apache::geode::client::CacheableDate.

◆ toString()

std::string apache::geode::client::UserFunctionExecutionException::toString ( ) const
inlineoverridevirtual

Display this object as 'string', which depends on the implementation in the subclasses.

The default implementation renders the classname.

Reimplemented from apache::geode::client::Serializable.


Apache Geode C++ Cache API Documentation