VMware Tanzu GemFire .NET Client API Reference

VMware Tanzu GemFire .NET Client: ITypeRegistry Interface Reference
VMware Tanzu GemFire .NET Client
Public Member Functions | Properties | List of all members
ITypeRegistry Interface Reference

Registry for custom serializable types, both PDXSerializable and DataSerializable. More...

Inherited by ITypeRegistryInternal.

Public Member Functions

int GetTypeId (Type type)
 Method to extract numeric type id from Type More...
 
void RegisterPdxType (PdxTypeFactoryMethod creationMethod)
 Register an instance factory method for a given type. This should be used when registering types that implement IPdxSerializable. More...
 
void RegisterType (TypeFactoryMethod creationMethod, int id)
 Register an instance factory method for a given type. This should be used when registering types that implement ISerializable. More...
 
object CreateObject (string classname)
 Method to construct a registered object, lookup via classname More...
 
dynamic GetPdxTypeFromId (int typeId)
 Method to extract Pdx type from internal map using id More...
 

Properties

IPdxSerializer PdxSerializer [get, set]
 Getter method for PdxSerializer More...
 
IPdxTypeMapper PdxTypeMapper [get, set]
 Register an PdxTypeMapper to map the local types to pdx types More...
 
bool PdxReadSerialized [get, set]
 Getter for property PdxReadSerialized More...
 

Detailed Description

Registry for custom serializable types, both PDXSerializable and DataSerializable.

Member Function Documentation

◆ CreateObject()

object ITypeRegistry.CreateObject ( string  classname)

Method to construct a registered object, lookup via classname

Parameters
classname
Returns
instance of registered object

◆ GetPdxTypeFromId()

dynamic ITypeRegistry.GetPdxTypeFromId ( int  typeId)

Method to extract Pdx type from internal map using id

Parameters
typeId
Returns
PdxType

◆ GetTypeId()

int ITypeRegistry.GetTypeId ( Type  type)

Method to extract numeric type id from Type

Exceptions
GemFireUnregisteredTypeExceptionWhen a type is unregistered i.e. user defined IDataSerializable
Parameters
type
Returns

◆ RegisterPdxType()

void ITypeRegistry.RegisterPdxType ( PdxTypeFactoryMethod  creationMethod)

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
InvalidOperationExceptionif duplicate type
GemFireIllegalArgumentExceptionif the method is null

◆ RegisterType()

void ITypeRegistry.RegisterType ( TypeFactoryMethod  creationMethod,
int  id 
)

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

Parameters
creationMethodthe creation function to register
idnumeric id to be used with this type
Exceptions
InvalidOperationExceptionif duplicate type
GemFireIllegalArgumentExceptionif the method is null

Property Documentation

◆ PdxReadSerialized

bool ITypeRegistry.PdxReadSerialized
getset

Getter for property PdxReadSerialized

◆ PdxSerializer

IPdxSerializer ITypeRegistry.PdxSerializer
getset

Getter method for PdxSerializer

◆ PdxTypeMapper

IPdxTypeMapper ITypeRegistry.PdxTypeMapper
getset

Register an PdxTypeMapper to map the local types to pdx types

The documentation for this interface was generated from the following file:
  • gemfire.client/Interfaces/ITypeRegistry.cs