VMware Tanzu GemFire .NET Client API Reference

VMware Tanzu GemFire .NET Client: Class List
VMware Tanzu GemFire .NET Client
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
 CCacheClosedExceptionException thrown when an operation is attempted upon a closed Cache
 CCacheFactoryThis factory class is the entry point and used to create the root class for this library
 CGemFireClientRequestTimedOutExceptionException for when client requests time out
 CGemFireExceptionBase exception for .NET client for GemFire
 CGemFireIllegalArgumentExceptionException for illegal arguments to this library
 CGemFireIllegalStateExceptionException used to indicate actions have resulted in an improper state of this library
 CGemFireQueryExceptionException related to Queries
 CGemFireResponseExceptionException for responses from server
 CGemFireSecureSocketsRequiredExceptionException used to indicate that TLS is enabled on the Server and is required on the Client as well
 CGemFireSubscriptionReauthenticateExceptionException to indicate the server has requested re-authentication on subscription channel
 CGemFireTypeExceptionException denoting an issue with type and/or serialization of a type
 CGemFireUnregisteredPdxTypeExceptionException denoting attempted usage of an unregistered Pdx type
 CGemFireUnregisteredTypeExceptionException for unregistered types
 CIAuthInitializeSpecifies the mechanism to obtain credentials for a client
 CICacheProvides a client cache
 CICacheableKeyThis interface class is the superclass of all user objects in the cache that can be used as a key
 CICacheExecutionInterface used to perform ICache level function execution
 CICacheFactoryThis interface provides for the configuration and creation of instances of Cache. Setters and configuration methods all return ICacheFactory to enable use of the Builder pattern
 CICacheFunctionServiceInterface for Cache level Function Service
 CICacheListenerAn application plug-in that can be installed on a region
 CICqAttributesDefines attributes for configuring a cq
 CICqAttributesFactoryInterface for CQ attributes factory
 CICqEventInterface representing Continuous Query events from server
 CICqListenerAn application plug-in that can be installed on a region. Continuous Query Listener change notifications are invoked after the change has occured
 CICqQueryClass to encapsulate a continuous query (CQ)
 CIDataInputProvides operations for reading primitive data values, byte arrays, strings, ISerializable objects from a byte stream
 CIDataOutputProvides operations for writing primitive data values, and user-defined objects implementing ISerializable, to a byte stream. This class is intentionally not thread safe
 CIDataSerializableInterface for user defined serializable domain objects
 CIEntryEventThis class encapsulates events that occur for an entry in a region
 CIJsonDocumentInterface for JsonDocument
 CIJsonDocumentFactoryInterface for Json document factory
 CIJsonSerialCacheableInherit from this interface to allow a class instance to be cached to GemFire as serialized, queryable JSON. If a region's TValue is typed with a class implementing this interface, the default System.Text.Json deserializer will be used, i.e. System.Text.Json.JsonSerializer This allows for custom serialization and deserialization through System.Text.Json attributes (e.g. [JsonConverter], [JsonPropertyName])
 CIOpMetricInterface for Operation Metrics
 CIPartitionResolverImplementers of interface
 CIPdxInstancePdxInstance provides run time access to the fields of a PDX without deserializing the PDX. Preventing deserialization saves time and memory and does not require the domain class. This interface is implemented by NativeClient. The PdxInstance implementation is a light weight wrapper that simply refers to the raw bytes of the PDX that are kept in the cache. Applications can choose to access PdxInstances instead of .NET objects by configuring the Cache to prefer PDX instances during deserialization. This can be done programmatically using the CacheFactory.SetPdxReadSerialized method. Once this preference is configured, then any time deserialization of a PDX is done it will deserialize into a PdxInstance. PdxInstance are immutable. If you want to change one call see cref="CreateWriter"/>
 CIPdxInstanceFactoryPdxInstanceFactory gives you a way to create PdxInstances. Call the write methods to populate the field data and then call Create to produce an actual instance that contains the data. To create a factory call ICache.CreatePdxInstanceFactory. A factory can only create a single instance. To create multiple instances create multiple factories or use IPdxInstance.CreateWriter to create subsequent instances
 CIPdxReaderA IPdxReader will be passed to IPdxSerializable.fromData or during deserialization of a PDX. The domain class needs to deserialize field members using this interface. Each readXXX call will return the field's value. If the serialized PDX does not contain the named field then a default value will be returned. Standard Java defaults are used. For Objects this is null and for primitives it is 0 or 0.0
 CIPdxSerializableWhen a domain class implements PdxSerializable it marks itself as a PDX. The implementation of toData provides the serialization code and fromData provides the deserialization code. These methods also define each field name and field type of the PDX. Domain classes should serialize and de-serialize all its member fields in same order in toData and fromData method. A domain class which implements this interface should register delgate ITypeRegistry.RegisterPdxType to create new instance of type for de-serialization
 CIPdxSerializerThe IPdxSerializer interface allows domain classes to be serialized and deserialized as PDXs without modification of the domain class. A domain class should register delgate ITypeRegistry.RegisterPdxType to create new instance of type for de-serialization
 CIPdxTypeMapperInterface for mapping Pdx types
 CIPdxUnreadFieldsInterface for Pdx unread Fields
 CIPdxWriterA IPdxWriter will be passed to IPdxSerializable.toData when it is serializing the domain class. The domain class needs to serialize member fields using this interface
 CIPersistenceManagerIPersistenceManager interface for persistence and overflow. This class abstracts the disk-related operations in case of persistence or overflow to disk. A specific disk storage implementation will implement all the methods described here
 CIPoolA pool of connections
 CIPropertiesProvides a collection of properties, each of which is a key/value pair. Each key is a string, and the value may be a string or an integer
 CIQueryClass to encapsulate a remote query
 CIQueryServiceProvides a query service
 CIReflectionBasedAutoSerializerInterface for reflection based automatic serializer
 CIRegionEncapsulates a concrete region of cached data
 CIRegionEventThis class encapsulates events that occur for a region
 CIRegionExecutionInterface for IRegion<TKey, TValue> level function executor
 CIRegionFactoryThis interface provides for the configuration and creation of instances of Region
 CIRegionFunctionServiceInterface for IRegion<TKey, TValue> function services
 CIResultCollectorInterface for result collection from queries
 CISerializableThis interface class is the superclass of all user objects in the cache that can be serialized
 CISubscriptionServiceThis generic interface class provides all Register Interest API's for GemFire's generic non local region IRegion<TKey, TValue>
 CISystemPropertiesA class that encapsulates the GemFire client properties
 CITransactionIdInterface for Transaction Ids
 CITransactionManagerITransactionManager encapsulates the transactions for a cache
 CITypeRegistryRegistry for custom serializable types, both PDXSerializable and DataSerializable
 CIWritablePdxInstanceWritablePdxInstance is a IPdxInstance that also supports field modification using the SetFieldmethod. To get a WritablePdxInstance call IPdxInstance.CreateWriter