UserFunctionExecutionException class is used to encapsulate geode sendException in case of Function execution.
More...
Inherits apache::geode::client::Serializable.
UserFunctionExecutionException class is used to encapsulate geode sendException in case of Function execution.
| virtual apache::geode::client::UserFunctionExecutionException::~UserFunctionExecutionException |
( |
| ) |
|
|
inlinevirtual |
public methods
destructor
| apache::geode::client::UserFunctionExecutionException::UserFunctionExecutionException |
( |
CacheableStringPtr |
msg | ) |
|
| virtual int32_t apache::geode::client::UserFunctionExecutionException::classId |
( |
| ) |
const |
|
virtual |
Return the classId of the instance being serialized.
This is used by deserialization to determine what instance type to create and deserialize into.
The classId must be unique within an application suite. Using a negative value may result in undefined behavior.
- Exceptions
-
| IllegalStateException | If this api is called from User code. |
Implements apache::geode::client::Serializable.
template<class PRIM >
| static SerializablePtr apache::geode::client::Serializable::create |
( |
const PRIM |
value | ) |
|
|
inlinestaticinherited |
Factory method that creates the Serializable object that matches the type of value.
For customer defined derivations of Serializable, the method apache::geode::client::createValue may be overloaded. For pointer types (e.g. char*) the method apache::geode::client::createValueArr may be overloaded.
| virtual int8_t apache::geode::client::Serializable::DSFID |
( |
| ) |
const |
|
virtualinherited |
| virtual Serializable* apache::geode::client::UserFunctionExecutionException::fromData |
( |
DataInput & |
input | ) |
|
|
virtual |
deserialize this object, typical implementation should return the 'this' pointer.
- Exceptions
-
| IllegalStateException | If this api is called from User code. |
Implements apache::geode::client::Serializable.
return as CacheableStringPtr the Exception message returned from geode sendException api.
return as CacheableStringPtr the Exception name returned from geode sendException api.
| virtual uint32_t apache::geode::client::UserFunctionExecutionException::objectSize |
( |
| ) |
const |
|
virtual |
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.
- Exceptions
-
| IllegalStateException | If this api is called from User code. |
Reimplemented from apache::geode::client::Serializable.
| void apache::geode::client::SharedBase::preserveSB |
( |
| ) |
const |
|
inherited |
Atomically increment reference count.
| int32_t apache::geode::client::SharedBase::refCount |
( |
| ) |
|
|
inlineinherited |
- Returns
- the reference count
| static void apache::geode::client::Serializable::registerPdxSerializer |
( |
PdxSerializerPtr |
pdxSerializer | ) |
|
|
staticinherited |
Register the PDX serializer which can handle serialization for instances of user domain classes.
- See also
- PdxSerializer
| static void apache::geode::client::Serializable::registerPdxType |
( |
TypeFactoryMethodPdx |
creationFunction | ) |
|
|
staticinherited |
register an Pdx instance factory method for a given type.
- Exceptions
-
| IllegalStateException | if the typeName has already been registered, or there is an error in registering the type; check errno for more information in the latter case. |
| static void apache::geode::client::Serializable::registerType |
( |
TypeFactoryMethod |
creationFunction | ) |
|
|
staticinherited |
register an instance factory method for a given type.
During registration the factory will be invoked to extract the typeId to associate with this function.
- Exceptions
-
| IllegalStateException | if the typeId has already been registered, or there is an error in registering the type; check errno for more information in the latter case. |
| void apache::geode::client::SharedBase::releaseSB |
( |
| ) |
const |
|
inherited |
Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
| virtual void apache::geode::client::UserFunctionExecutionException::toData |
( |
DataOutput & |
output | ) |
const |
|
virtual |
Display this object as 'string', which depends on the implementation in the subclasses.
The default implementation renders the classname.
The return value may be a temporary, so the caller has to ensure that the SharedPtr count does not go down to zero by storing the result in a variable or otherwise.
Reimplemented in apache::geode::client::PdxInstance, apache::geode::client::CacheableString, apache::geode::client::CacheableDate, apache::geode::client::CacheableEnum, and apache::geode::client::CacheableKeyType< TObj, TYPEID, TYPENAME, SPRINTFSYM, STRSIZE >.
| virtual int8_t apache::geode::client::UserFunctionExecutionException::typeId |
( |
| ) |
const |
|
virtual |
return the typeId byte of the instance being serialized.
This is used by deserialization to determine what instance type to create and deserialize into.
Note that this should not be overridden by custom implementations and is reserved only for builtin types.
Reimplemented from apache::geode::client::Serializable.
