Represents a cacheable key. More...

#include <CacheableKey.hpp>

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

Inherited by apache::geode::client::CacheableDate, apache::geode::client::CacheableEnum, apache::geode::client::CacheableString, and apache::geode::client::PdxSerializable [virtual].

Public Member Functions
virtual int32_t	hashcode () const =0
	return the hashcode for this key.

virtual size_t	objectSize () const
	return the size in bytes of the instance being serialized.

virtual bool	operator== (const CacheableKey &other) const =0
	return true if this key matches other.

virtual std::string	toString () const
	Display this object as 'string', which depends on the implementation in the subclasses.

Static Public Member Functions
template<class _T >
static std::shared_ptr< CacheableKey >	create (_T value)
	Factory method that creates the key type that matches the type of value.

Detailed Description

Represents a cacheable key.

Member Function Documentation

◆ create()

template<class _T >

static std::shared_ptr< CacheableKey > apache::geode::client::CacheableKey::create ( _T value )

static

Factory method that creates the key type that matches the type of value.

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

◆ hashcode()

virtual int32_t apache::geode::client::CacheableKey::hashcode ( ) const

pure virtual

return the hashcode for this key.

Implemented in apache::geode::client::CacheableDate, apache::geode::client::CacheableEnum, apache::geode::client::CacheableFileName, apache::geode::client::CacheableString, apache::geode::client::PdxSerializable, apache::geode::client::PdxWrapper, and apache::geode::client::PdxInstance.

◆ 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::CacheableDate, apache::geode::client::CacheableEnum, apache::geode::client::CacheableString, and apache::geode::client::PdxInstance.

◆ operator==()

virtual bool apache::geode::client::CacheableKey::operator== ( const CacheableKey & other ) const

pure virtual

return true if this key matches other.

Implemented in apache::geode::client::CacheableDate, apache::geode::client::CacheableEnum, apache::geode::client::CacheableString, apache::geode::client::PdxSerializable, apache::geode::client::PdxWrapper, and apache::geode::client::PdxInstance.

◆ toString()

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

virtualinherited

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

The default implementation renders the classname.

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

Public Member Functions