An immutable wrapper for byte arrays that can serve as a distributable object for caching. More...

Inherits apache::geode::client::CacheableArrayType< TObj, TYPEID >.

Public Member Functions
virtual int32_t	classId () const
	Return the classId of the instance being serialized. More...

virtual int8_t	DSFID () const
	return the Data Serialization Fixed ID type. More...

virtual Serializable *	fromData (DataInput &input)
	Deserialize this object from the given `DataInput`. More...

int32_t	length () const
	Get the length of the array. More...

virtual uint32_t	objectSize () const
	Return the size in bytes of the instance being serialized. More...

TObj	operator[] (uint32_t index) const
	Get the element at given index. More...

void	preserveSB () const
	Atomically increment reference count. More...

int32_t	refCount ()

void	releaseSB () const
	Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero. More...

virtual void	toData (DataOutput &output) const
	Serialize this object to the given `DataOutput`. More...

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

virtual int8_t	typeId () const
	Return the typeId byte of the instance being serialized. More...

const TObj *	value () const
	Get the underlying array. More...

Static Public Member Functions
template<class PRIM >
static SerializablePtr	create (const PRIM value)
	Factory method that creates the Serializable object that matches the type of value. More...

static CacheableBytesPtr	create ()
	Factory function to create a new default instance. More...

static CacheableBytesPtr	create (const uint8_t *value, int32_t length)
	Create a cacheable array copying from the given array. More...

static CacheableBytesPtr	create (int32_t length)
	Factory function to create a cacheable array of given size. More...

static Serializable *	createDeserializable ()
	Factory function registered with serialization registry. More...

static CacheableBytesPtr	createNoCopy (uint8_t *value, int32_t length)
	\ \ * \ \ * \ \ \ * Create a cacheable array taking ownership of the given array \ \ * \ \ * \ \ \ * without creating a copy. More...

static void	registerPdxSerializer (PdxSerializerPtr pdxSerializer)
	Register the PDX serializer which can handle serialization for instances of user domain classes. More...

static void	registerPdxType (TypeFactoryMethodPdx creationFunction)
	register an Pdx instance factory method for a given type. More...

static void	registerType (TypeFactoryMethod creationFunction)
	register an instance factory method for a given type. More...

Detailed Description

An immutable wrapper for byte arrays that can serve as a distributable object for caching.

Member Function Documentation

template<typename TObj , int8_t TYPEID>

virtual int32_t apache::geode::client::CacheableArrayType< TObj, TYPEID >::classId ( ) const

inlinevirtualinherited

Return the classId of the instance being serialized.

This is used by deserialization to determine what instance type to create and deserialize into.

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.

static CacheableBytesPtr apache::geode::client::CacheableBytes::create ( )

inlinestatic

Factory function to create a new default instance.

static CacheableBytesPtr apache::geode::client::CacheableBytes::create	(	const uint8_t *	value,
		int32_t	length
	)

inlinestatic

Create a cacheable array copying from the given array.

static CacheableBytesPtr apache::geode::client::CacheableBytes::create ( int32_t length )

inlinestatic

Factory function to create a cacheable array of given size.

static Serializable* apache::geode::client::CacheableBytes::createDeserializable ( )

inlinestatic

Factory function registered with serialization registry.

static CacheableBytesPtr apache::geode::client::CacheableBytes::createNoCopy	(	uint8_t *	value,
		int32_t	length
	)

inlinestatic

\ \ * \ \ * \ \ \ * Create a cacheable array taking ownership of the given array \ \ * \ \ * \ \ \ * without creating a copy.

\ \ * \ \ * \ \ \ * \ \ * \ \ * \ \ \ * Note that the application has to ensure that the given array is \ \ * \ \ * \ \ \ * not deleted (apart from this class) and is allocated on the heap \ \ * \ \ * \ \ \ * using the "new" operator. \ \ * \ \ * \ \ \

virtual int8_t apache::geode::client::Serializable::DSFID ( ) const

virtualinherited

return the Data Serialization Fixed ID type.

This is used 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 in apache::geode::client::Struct, and apache::geode::client::CacheableUndefined.

template<typename TObj , int8_t TYPEID>

virtual Serializable* apache::geode::client::CacheableArrayType< TObj, TYPEID >::fromData ( DataInput & input )

inlinevirtualinherited

Deserialize this object from the given DataInput.

Implements apache::geode::client::Serializable.

template<typename TObj , int8_t TYPEID>

int32_t apache::geode::client::CacheableArrayType< TObj, TYPEID >::length ( ) const

inlineinherited

Get the length of the array.

template<typename TObj , int8_t TYPEID>

virtual uint32_t apache::geode::client::CacheableArrayType< TObj, TYPEID >::objectSize ( ) const

inlinevirtualinherited

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.

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

template<typename TObj , int8_t TYPEID>

TObj apache::geode::client::CacheableArrayType< TObj, TYPEID >::operator[] ( uint32_t index ) const

inlineinherited

Get the element at given index.

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.

template<typename TObj , int8_t TYPEID>

virtual void apache::geode::client::CacheableArrayType< TObj, TYPEID >::toData ( DataOutput & output ) const

inlinevirtualinherited

Serialize this object to the given DataOutput.

Implements apache::geode::client::Serializable.

virtual CacheableStringPtr 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.

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 >.

template<typename TObj , int8_t TYPEID>

virtual int8_t apache::geode::client::CacheableArrayType< TObj, TYPEID >::typeId ( ) const

inlinevirtualinherited

Return the typeId byte of the instance being serialized.

This is used by deserialization to determine what instance type to create and deserialize into.

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

template<typename TObj , int8_t TYPEID>

const TObj* apache::geode::client::CacheableArrayType< TObj, TYPEID >::value ( ) const

inlineinherited

Get the underlying array.

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation