GemStone.GemFire.Cache NamespacePivotal GemFire .NET Client Documentation
This namespace contains all the Pivotal GemFire .NET Client API classes and enumerations.
Classes

  ClassDescription
Public classAllConnectionsInUseException
Thrown when all connections in a pool are in use..
Public classAlreadyConnectedException
Thrown when an attempt is made to connect to DistributedSystem second time.
Public classAssertionException
A gemfire assertion exception.
Public classAttributesFactoryObsolete.
Factory class to create instances of RegionAttributes.
Public classAttributesMutatorObsolete.
Supports modification of certain region attributes after the region has been created.
Public classAuthenticatedCache
Provides a distributed cache.
Public classAuthenticationFailedException
Thrown when authentication to the server fails.
Public classAuthenticationRequiredException
Thrown when credentials are not provided to a server which expects them.
Public classBooleanArray
An immutable wrapper for array of booleans that can serve as a distributable object for caching.
Public classBufferSizeExceededException
Thrown when the internal buffer size is exceeded.
Public classCacheObsolete.
Provides a distributed cache.
Public classCacheableArrayListObsolete.
A mutable IGFSerializable vector wrapper that can serve as a distributable object for caching. This class extends .NET generic List class.
Public classCacheableBoolean
An immutable wrapper for booleans that can serve as a distributable key object for caching.
Public classCacheableByte
An immutable wrapper for bytes that can serve as a distributable key object for caching.
Public classCacheableBytes
An immutable wrapper for byte arrays that can serve as a distributable object for caching.
Public classCacheableCharacter
An immutable wrapper for 16-bit characters that can serve as a distributable key object for caching.
Public classCacheableDateObsolete.
An immutable date wrapper that can serve as a distributable key object for caching as well as being a string value.
Public classCacheableDouble
An immutable wrapper for doubles that can serve as a distributable key object for caching.
Public classCacheableDoubleArray
An immutable wrapper for array of doubles that can serve as a distributable object for caching.
Public classCacheableFileNameObsolete.
An immutable filename wrapper that can serve as a distributable key object for caching as well as being a string value.
Public classCacheableFloat
An immutable wrapper for floats that can serve as a distributable key object for caching.
Public classCacheableFloatArray
An immutable wrapper for array of floats that can serve as a distributable object for caching.
Public classCacheableHashMapObsolete.
A mutable ICacheableKey to IGFSerializable hash map that can serve as a distributable object for caching. This class extends .NET generic Dictionary class.
Public classCacheableHashSet
A mutable ICacheableKey hash set wrapper that can serve as a distributable object for caching.
Public classCacheableHashTableObsolete.
A mutable ICacheableKey to IGFSerializable hash table that can serve as a distributable object for caching. This class extends .NET generic Dictionary class.
Public classCacheableIdentityHashMapObsolete.
A mutable ICacheableKey to IGFSerializable hash map that can serve as a distributable object for caching. This class extends .NET generic Dictionary class. This class is meant as a means to interoperate with java server side IdentityHashMap class objects but is intentionally not intended to provide java.util.IdentityHashMap semantics.
Public classCacheableInt16
An immutable wrapper for 16-bit integers that can serve as a distributable key object for caching.
Public classCacheableInt16Array
An immutable wrapper for array of 16-bit integers that can serve as a distributable object for caching.
Public classCacheableInt32
An immutable wrapper for 32-bit integers that can serve as a distributable key object for caching.
Public classCacheableInt32Array
An immutable wrapper for array of 32-bit integers that can serve as a distributable object for caching.
Public classCacheableInt64
An immutable wrapper for 64-bit integers that can serve as a distributable key object for caching.
Public classCacheableInt64Array
An immutable wrapper for array of 64-bit integers that can serve as a distributable object for caching.
Public classCacheableKeyObsolete.
This class wraps the native C++ gemfire::Serializable objects as managed IGFSerializable objects.
Public classCacheableLinkedHashSet
A mutable ICacheableKey hash set wrapper that can serve as a distributable object for caching. This is provided for compability with java side though is functionally identical to CacheableHashSet i.e. does not provide the linked semantics of java LinkedHashSet.
Public classCacheableObjectObsolete.
An mutable generic Object wrapper that can serve as a distributable value for caching.
Public classCacheableObjectArrayObsolete.
A mutable IGFSerializable object array wrapper that can serve as a distributable object for caching. Though this class provides compatibility with java Object[] serialization, it provides the semantics of .NET generic List class.
Public classCacheableObjectXmlObsolete.
A mutable generic Object wrapper that can serve as a distributable value for caching.
Public classCacheableStackObsolete.
A mutable IGFSerializable vector wrapper that can serve as a distributable object for caching.
Public classCacheableStringObsolete.
An immutable string wrapper that can serve as a distributable key object for caching as well as being a string value.
Public classCacheableStringArrayObsolete.
An immutable wrapper for array of strings that can serve as a distributable object for caching.
Public classCacheableUndefinedObsolete.
Encapsulate an undefined result.
Public classCacheableVectorObsolete.
A mutable IGFSerializable vector wrapper that can serve as a distributable object for caching. This class extends .NET generic List class.
Public classCacheAttributesObsolete.
Defines attributes for configuring a cache.
Public classCacheAttributesFactoryObsolete.
Creates instances of CacheAttributes.
Public classCacheClosedException
Thrown when an operation is attempted on a closed cache.
Public classCacheExistsException
Thrown when an attempt is made to create an existing cache.
Public classCacheFactoryObsolete.
A factory class that must be used to obtain instance of Cache.
Public classCacheListenerAdapterObsolete.
Utility class that implements all methods in ICacheListener with empty implementations. Applications can subclass this class and only override the methods for the events of interest.
Public classCacheListenerException
Thrown when the cache listener throws an exception.
Public classCacheLoaderObsolete.
CacheLoader
Public classCacheLoaderException
Thrown when the cache loader aborts the operation.
Public classCacheProxyException
Thrown when there is an error in the cache proxy.
Public classCacheServerException
Thrown when an exception occurs on the cache server.
Public classCacheStatisticsObsolete.
Defines common statistical information for both the region and its entries.
Public classCacheWriterAdapterObsolete.
Utility class that implements all methods in ICacheWriter with empty implementations. Applications can subclass this class and only override the methods for the events of interest.
Public classCacheWriterException
Thrown when the cache writer aborts the operation.
Public classCacheXmlException
Thrown when the cache xml is incorrect.
Public classCharArray
An immutable wrapper for array of 16-bit characters that can serve as a distributable object for caching.
Public classClassCastException
Thrown when a cast operation fails.
Public classCommitConflictException
Thrown if commit fails.
Public classConcurrentModificationException
Thrown when a concurrent operation fails.
Public classCqAttributesObsolete.
Defines attributes for configuring a cq.
Public classCqAttributesFactoryObsolete.
Creates instances of CqAttributes.
Public classCqAttributesMutatorObsolete.
Supports modification of certain cq attributes after the cq has been created.
Public classCqClosedException
Thrown if the Cq on which the operaion performed is closed
Public classCqEventObsolete.
This class encapsulates events that occur for cq.
Public classCqException
Thrown during continuous query execution time.
Public classCqExistsException
Thrown if a Cq by this name already exists on this client
Public classCqInvalidException
Thrown when cq is invalid
Public classCqOperationObsolete.
Public classCqQueryObsolete.
Class to encapsulate a continuous query (CQ).
Public classCqQueryException
Thrown if the Cq Query failed
Public classCqServiceStatisticsObsolete.
Defines common statistical information for cqservice
Public classCqStateObsolete.
Static class containing convenience methods for CqState.
Public classCqStatisticsObsolete.
Defines common statistical information for a cq.
Public classDataInputObsolete.
Provides operations for reading primitive data values, byte arrays, strings, IGFSerializable objects from a byte stream.
Public classDataOutputObsolete.
Provides operations for writing primitive data values, and user-defined objects implementing IGFSerializable, to a byte stream. This class is intentionally not thread safe.
Public classDiskCorruptException
Thrown by the persistence manager when the data to be read from disk is corrupt.
Public classDiskFailureException
Thrown by the persistence manager when a write fails due to disk failure.
Public classDiskPolicyObsolete.
Static class containing convenience methods for DiskPolicyType.
Public classDistributedSystemObsolete.
DistributedSystem encapsulates this applications "connection" into the GemFire Java servers.
Public classDuplicateDurableClientException
Thrown when a duplicate durable client id is provided to the server.
Public classEntryDestroyedException
Thrown when an operation is attempted on a destroyed entry.
Public classEntryEventObsolete.
This class encapsulates events that occur for an entry in a region.
Public classEntryExistsException
Thrown when attempt is made to create an existing entry.
Public classEntryNotFoundException
Thrown when an operation is attempted on a non-existent entry.
Public classExecutionObsolete.
This class encapsulates events that occur for cq.
Public classExpiration
Static class containing convenience methods for ExpirationAction.
Public classFatalInternalException
Thrown when there is a fatal internal exception in GemFire.
Public classFileNotFoundException
Thrown when a non-existing file is accessed.
Public classFunctionExecutionException
Thrown when function execution failed
Public classFunctionServiceObsolete.
Public classGemFireClassIdsObsolete.
Static class containing the classIds of the built-in cacheable types.
Public classGemFireConfigException
Thrown when gemfire configuration file is incorrect.
Public classGemFireException
The base exception class of all managed GemFire exceptions.
Public classGemFireIOException
Thrown when there is an input/output error.
Public classIllegalArgumentException
Thrown when an argument to a method is illegal.
Public classIllegalStateException
Thrown when the state of cache is manipulated to be illegal.
Public classInitFailedException
Thrown when persistence manager fails to initialize.
Public classInterruptedException
Thrown when an operation is interrupted.
Public classInvalidDeltaException
Public classKeyNotFoundException
Thrown if a Key is not present in the region.
Public classLeaseExpiredException
Thrown when lease of cache proxy has expired.
Public classLogObsolete.
Defines methods available to clients that want to write a log message to their GemFire system's shared log file.
Public classMessageException
Thrown when an unknown message is received from the server.
Public classNoAvailableLocatorsException
Thrown when a client is unable to contact any locators.
Public classNoSystemException
Thrown when the connecting target is not running.
Public classNotAuthorizedException
Thrown when a client operation is not authorized on the server.
Public classNotConnectedException
Thrown when an operation is attempted before connecting to the distributed system.
Public classNotOwnerException
Thrown when an attempt is made to release a lock not owned by the thread.
Public classNullPointerException
Thrown when a null argument is provided to a method where it is expected to be non-null.
Public classOutOfMemoryException
Thrown when the system cannot allocate any more memory.
Public classOutOfRangeException
Thrown when bound of array/vector etc. is exceeded.
Public classPoolObsolete.
A pool of connections.
Public classPoolFactoryObsolete.
This interface provides for the configuration and creation of instances of Pool.
Public classPoolManagerObsolete.
This interface provides for the configuration and creation of instances of PoolFactory.
Public classPropertiesObsolete.
Provides 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.
Public classQueryObsolete.
Class to encapsulate a query.
Public classQueryException
Thrown when query exception occurs at the server.
Public classQueryServiceObsolete.
Provides a query service.
Public classRegionObsolete.
Encapsulates a concrete region of cached data.
Public classRegionAttributesObsolete.
Defines attributes for configuring a region.
Public classRegionCreationFailedException
Thrown when a region creation operation fails.
Public classRegionDestroyedException
Thrown when an operation is attempted on a destroyed region.
Public classRegionEntryObsolete.
An object in a region that represents an entry, that is, a key-value pair.
Public classRegionEventObsolete.
This class encapsulates events that occur for a region.
Public classRegionExistsException
Thrown when an attempt is made to create an existing region.
Public classRegionFactoryObsolete.
This interface provides for the configuration and creation of instances of Region.
Public classResultCollectorObsolete.
collect function execution results, default collector
Public classResultSetObsolete.
Encapsulates a query result set. It specifies the interface for the resultset obtained from the Gemfire cache server
Public classSafeConvertClass
Public classScopeObsolete.
Static class containing convenience methods for ScopeType.
Public classSelectResultsIteratorObsolete.
Iterator for a query result.
Public classSerializableObsolete.
This class wraps the native C++ gemfire::Serializable objects as managed IGFSerializable objects.
Public classShutdownFailedException
Thrown when persistence manager fails to close properly.
Public classStatisticDescriptorObsolete.
A class that describes an individual statistic whose value is updated by an application and may be archived by GemFire. These descriptions are gathered together in a StatisticsType class.
Public classStatisticsObsolete.
An instantiation of an existing StatisticsType object with methods for setting, incrementing and getting individual StatisticDescriptor values.
Public classStatisticsDisabledException
Thrown when statistics are invoked for a region where they are disabled.
Public classStatisticsFactoryObsolete.
Instances of this interface provide methods that create instances of StatisticDescriptor and StatisticsType. Every StatisticsFactory is also a type factory.
Public classStatisticsTypeObsolete.
This class is used to describe a logical collection of StatisticDescriptors.These descriptions are used to create an instance of Statistics class.
Public classStructObsolete.
Encapsulates a row of query struct set.
Public classStructSetObsolete.
Encapsulates a query struct set.
Public classSystemPropertiesObsolete.
A class for internal use, that encapsulates the properties that can be set through Connect(String) or a gfcpp.properties file.
Public classTimeoutException
Thrown when a timout occurs.
Public classTransactionDataNodeHasDepartedException
Thrown if transaction delegate went down.
Public classTransactionDataRebalancedException
Thrown if commit rebalance happens during a transaction.
Public classUnknownException
An unknown exception occurred.
Public classUnsupportedOperationException
Thrown when an operation unsupported by the current configuration is attempted.
Public classUserFunctionExecutionExceptionObsolete.
UserFunctionExecutionException class is used to encapsulate gemfire sendException in case of Function execution.
Public classWrongRegionScopeException
Thrown when a region is created in an incorrect scope.
Interfaces

  InterfaceDescription
Public interfaceIAuthInitializeObsolete.
Specifies the mechanism to obtain credentials for a client. It is mandantory for clients when the server is running in secure mode having a security-client-authenticator module specified. Implementations should register the library path as security-client-auth-library system property and factory function (a zero argument function returning pointer to an AuthInitialize object) as the security-client-auth-factory system property. For a managed class implementing IAuthInitialize the fully qualified name of the factory function should be provided in the form {Namespace}.{Class Name}.{Method Name} as the security-client-auth-factory property.
Public interfaceICacheableKeyObsolete.
This interface class is the superclass of all user objects in the cache that can be used as a key.
Public interfaceICacheListenerObsolete.
An application plug-in that can be installed on a region.
Public interfaceICacheLoaderObsolete.
A data-loading application plug-in that can be installed on a region.
Public interfaceICacheWriterObsolete.
An application plug-in that can be installed on a region. Defines methods that are called before entry modification, such as writing the value to a database.
Public interfaceICqEventObsolete.
An application plug-in that can be installed on a region. Listener change notifications are invoked after the change has occured.
Public interfaceICqListenerObsolete.
An application plug-in that can be installed on a region. Listener change notifications are invoked after the change has occured.
Public interfaceICqResultsObsolete.
Interface to encapsulate a select query result set.
Public interfaceICqStatusListenerObsolete.
Extension of CqListener. Adds two new methods to CqListener, one that is called when the cq is connected and one that is called when the cq is disconnected.
Public interfaceIFixedPartitionResolverObsolete.
Public interfaceIGemFireCacheObsolete.
GemFireCache represents the singleton cache that must be created in order to connect to Gemfire server.
Public interfaceIGFDeltaObsolete.
This interface is used for delta propagation. To use delta propagation, an application class must implement interfaces IGFDelta as well as IGFSerializable. The IGFDelta interface methods HasDelta( ), ToDelta( ) and FromDelta( ) must be implemented by the class, as these methods are used by GemFire to detect the presence of delta in an object, to serialize the delta, and to apply a serialized delta to an existing object of the class. If a customized cloning method is required, the class must also implement the interface System.ICloneable. To use cloning in delta propagation for a region, the region attribute for cloning must be enabled.
Public interfaceIGFSerializableObsolete.
This interface class is the superclass of all user objects in the cache that can be serialized.
Public interfaceIPartitionResolverObsolete.
Public interfaceIRegionServiceObsolete.
Public interfaceIResultCollectorObsolete.
collect function execution results, can be overriden
Public interfaceISelectResultsObsolete.
Interface to encapsulate a select query result set.
Delegates

  DelegateDescription
Public delegatePropertyVisitor
Delegate that represents visitor for the Properties class.
Public delegateTypeFactoryMethod
Signature of function delegates passed to RegisterType(TypeFactoryMethod). Such functions should return an empty instance of the type they represent. The delegate shall be stored in the internal DelegateWrapper class and an instance will be initialized in the DelegateWrapper.NativeDelegate method by a call to FromData(DataInput).
Enumerations

  EnumerationDescription
Public enumerationCqOperationTypeObsolete.
Enumerated type for CqOperationType
Public enumerationCqStateTypeObsolete.
Enumerated type for cq state @nativeclient For Native Clients: @endnativeclient
Public enumerationDiskPolicyTypeObsolete.
Enumerated type for disk policy. Contains values for setting the disk policy type.
Public enumerationExpirationActionObsolete.
Enumerated type for expiration (LRU) actions. Contains values for setting an action type.
Public enumerationLogLevelObsolete.
Logging levels.
Public enumerationRegionShortcutObsolete.
Public enumerationScopeTypeObsolete.
Enumerated type for region distribution scope. Contains values for setting Scope. Local scope is invalid (it is a non-native client local region), and DistributedAck and DistributedNoAck have the same behavior.