VMware GemFire Native .NET Reference  9.2.4
Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID > Class Template Reference

An immutable template array wrapper that can serve as a distributable object for caching. More...

Inherits Apache::Geode::Client::Serializable.

Public Member Functions

virtual IGeodeSerializableFromData (DataInput^ input) override
 Deserializes the native (C++) object – returns an instance of the Serializable class with the native object wrapped inside. More...
 
virtual void ToData (DataOutput^ output) override
 Serializes this native (C++) object. More...
 
virtual String ^ ToString () override
 Return a string representation of the object. More...
 

Static Public Member Functions

static operator Apache::Geode::Client::Serializable^ (array< bool >^ value)
 Implicit conversion operator from an boolean array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< Byte >^ value)
 Implicit conversion operator from an array of bytes to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< Char >^ value)
 Implicit conversion operator from a character array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< Double >^ value)
 Implicit conversion operator from a double array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< Single >^ value)
 Implicit conversion operator from a float array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< String^>^ value)
 Implicit conversion operator from a string array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< System::Int16 >^ value)
 Implicit conversion operator from a 16-bit integer array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< System::Int32 >^ value)
 Implicit conversion operator from a 32-bit integer array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (array< System::Int64 >^ value)
 Implicit conversion operator from a 64-bit integer array to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (bool value)
 Implicit conversion operator from a boolean to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (Byte value)
 Implicit conversion operator from a byte to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (Char value)
 Implicit conversion operator from a character to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (Double value)
 Implicit conversion operator from a double to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (Single value)
 Implicit conversion operator from a float to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (String^ value)
 Implicit conversion operator from a string to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (System::Int16 value)
 Implicit conversion operator from a 16-bit integer to a Serializable. More...
 
static operator Apache::Geode::Client::Serializable^ (System::Int32 value)
 Implicit conversion operator from a 32-bit integer to a Serializable. More...
 
static operator Serializable^ (System::Int64 value)
 Implicit conversion operator from a 64-bit integer to a Serializable. More...
 
static void RegisterPdxSerializer (IPdxSerializer^ pdxSerializer)
 Set the PDX serializer for the cache. More...
 
static void RegisterPdxType (PdxTypeFactoryMethod^ creationMethod)
 
static void RegisterTypeGeneric (TypeFactoryMethodGeneric^ creationMethod)
 Register an instance factory method for a given type. More...
 
static void SetPdxTypeMapper (IPdxTypeMapper^ pdxTypeMapper)
 Register an PdxTypeMapper to map the local types to pdx types More...
 

Protected Member Functions

 CacheableBuiltinArray ()
 Protected constructor More...
 
 CacheableBuiltinArray (apache::geode::client::Serializable *nptr)
 Protected constructor to wrap a native object pointer More...
 
 CacheableBuiltinArray (array< TManaged >^ buffer)
 Allocates a new instance copying from the given array. More...
 
 CacheableBuiltinArray (array< TManaged >^ buffer, System::Int32 length)
 Allocates a new instance copying given length from the start of given array. More...
 

Properties

virtual System::UInt32 ClassId [get]
 Returns the classId of the instance being serialized. More...
 
TManaged Item [get]
 Returns the value at the given index. More...
 
System::Int32 Length [get]
 Returns the size of this array. More...
 
array< TManaged >^ Value [get]
 Returns a copy of the underlying array. More...
 

Detailed Description

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
class Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >

An immutable template array wrapper that can serve as a distributable object for caching.

Constructor & Destructor Documentation

◆ CacheableBuiltinArray() [1/4]

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::CacheableBuiltinArray ( )
inlineprotected

Protected constructor

◆ CacheableBuiltinArray() [2/4]

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::CacheableBuiltinArray ( apache::geode::client::Serializable *  nptr)
inlineprotected

Protected constructor to wrap a native object pointer

Parameters
nativeptrThe native object pointer

◆ CacheableBuiltinArray() [3/4]

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::CacheableBuiltinArray ( array< TManaged >^  buffer)
inlineprotected

Allocates a new instance copying from the given array.

This method performs no argument checking which is the responsibility of the caller.

Parameters
bufferthe array to copy from

◆ CacheableBuiltinArray() [4/4]

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::CacheableBuiltinArray ( array< TManaged >^  buffer,
System::Int32  length 
)
inlineprotected

Allocates a new instance copying given length from the start of given array.

This method performs no argument checking which is the responsibility of the caller.

Parameters
bufferthe array to copy from
lengthlength of array from start to copy

Member Function Documentation

◆ FromData()

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
virtual IGeodeSerializable ^ Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::FromData ( DataInput input)
inlineoverridevirtual

Deserializes the native (C++) object – returns an instance of the Serializable class with the native object wrapped inside.

Parameters
inputthe DataInput stream to use for reading the object data
Returns
the deserialized object

Reimplemented from Apache::Geode::Client::Serializable.

◆ operator Apache::Geode::Client::Serializable^() [1/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< bool >^  value)
staticinherited

Implicit conversion operator from an boolean array to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [2/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Byte >^  value)
staticinherited

Implicit conversion operator from an array of bytes to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [3/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Char >^  value)
staticinherited

Implicit conversion operator from a character array to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [4/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Double >^  value)
staticinherited

Implicit conversion operator from a double array to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [5/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< Single >^  value)
staticinherited

Implicit conversion operator from a float array to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [6/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< String^>^  value)
staticinherited

Implicit conversion operator from a string array to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [7/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int16 >^  value)
staticinherited

Implicit conversion operator from a 16-bit integer array to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [8/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int32 >^  value)
staticinherited

Implicit conversion operator from a 32-bit integer array to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [9/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( array< System::Int64 >^  value)
staticinherited

Implicit conversion operator from a 64-bit integer array to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [10/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( bool  value)
staticinherited

Implicit conversion operator from a boolean to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [11/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Byte  value)
staticinherited

Implicit conversion operator from a byte to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [12/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Char  value)
staticinherited

Implicit conversion operator from a character to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [13/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Double  value)
staticinherited

Implicit conversion operator from a double to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [14/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( Single  value)
staticinherited

Implicit conversion operator from a float to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [15/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( String^  value)
staticinherited

Implicit conversion operator from a string to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [16/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( System::Int16  value)
staticinherited

Implicit conversion operator from a 16-bit integer to a Serializable.

◆ operator Apache::Geode::Client::Serializable^() [17/17]

static Apache::Geode::Client::Serializable::operator Apache::Geode::Client::Serializable^ ( System::Int32  value)
staticinherited

Implicit conversion operator from a 32-bit integer to a Serializable.

◆ operator Serializable^()

static Apache::Geode::Client::Serializable::operator Serializable^ ( System::Int64  value)
staticinherited

Implicit conversion operator from a 64-bit integer to a Serializable.

◆ RegisterPdxSerializer()

static void Apache::Geode::Client::Serializable::RegisterPdxSerializer ( IPdxSerializer pdxSerializer)
staticinherited

Set the PDX serializer for the cache.

If this serializer is set, it will be consulted to see if it can serialize any domain classes which are added to the cache in portable data exchange format.

◆ RegisterPdxType()

static void Apache::Geode::Client::Serializable::RegisterPdxType ( PdxTypeFactoryMethod creationMethod)
staticinherited

Register an instance factory method for a given type. This should be used when registering types that implement IPdxSerializable.

Parameters
creationMethodthe creation function to register
Exceptions
IllegalArgumentExceptionif the method is null

◆ RegisterTypeGeneric()

static void Apache::Geode::Client::Serializable::RegisterTypeGeneric ( TypeFactoryMethodGeneric creationMethod)
staticinherited

Register an instance factory method for a given type.

This should be used when registering types that implement IGeodeSerializable.

Parameters
creationMethodthe creation function to register
Exceptions
IllegalArgumentExceptionif the method is null
IllegalStateExceptionif the typeId has already been registered, or there is an error in registering the type; check Utils::LastError for more information in the latter case.

◆ SetPdxTypeMapper()

static void Apache::Geode::Client::Serializable::SetPdxTypeMapper ( IPdxTypeMapper pdxTypeMapper)
staticinherited

Register an PdxTypeMapper to map the local types to pdx types

Parameters
pdxTypeMapperObject which implements IPdxTypeMapper interface

◆ ToData()

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
virtual void Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::ToData ( DataOutput output)
inlineoverridevirtual

Serializes this native (C++) object.

Parameters
outputthe DataOutput object to use for serializing the object

Reimplemented from Apache::Geode::Client::Serializable.

◆ ToString()

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
virtual String ^ Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::ToString ( )
inlineoverridevirtual

Return a string representation of the object.

It simply returns the string representation of the underlying native object by calling its toString() function.

Reimplemented from Apache::Geode::Client::Serializable.

Property Documentation

◆ ClassId

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
virtual System:: UInt32 Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::ClassId
get

Returns the classId of the instance being serialized.

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

Returns
the classId

◆ Item

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
TManaged Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::Item
get

Returns the value at the given index.

◆ Length

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
System:: Int32 Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::Length
get

Returns the size of this array.

◆ Value

template<typename TNative, typename TNativePtr, typename TManaged, System::UInt32 TYPEID>
array< TManaged>^ Apache::Geode::Client::CacheableBuiltinArray< TNative, TNativePtr, TManaged, TYPEID >::Value
get

Returns a copy of the underlying array.


VMware GemFire .NET Cache API Documentation