Apache Geode Native C++ Reference 1.15.0
apache::geode::client::Serializable Class Reference

This base class is the superclass of all user objects in the cache that can be serialized. More...

#include <Serializable.hpp>

Inherited by apache::geode::client::CacheableKey [virtual], apache::geode::client::DataSerializable [virtual], apache::geode::client::PdxSerializable [virtual], and apache::geode::client::UserFunctionExecutionException.

Public Member Functions

virtual size_t objectSize () const
 return the size in bytes of the instance being serialized. More...
 
virtual std::string toString () const
 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

This base class is the superclass of all user objects in the cache that can be serialized.

Member Function Documentation

◆ create()

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

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.

◆ objectSize()

virtual size_t apache::geode::client::Serializable::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.

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

◆ toString()

virtual std::string apache::geode::client::Serializable::toString ( ) const
virtual

Apache Geode C++ Cache API Documentation