This namespace contains all the GemFire C++ API classes, enumerations and globals. More...

Namespaces
	TypeHelper
	This namespace contains type traits helper structs/classes to determine type information at compile time using typename.

Data Structures
class	Assert
	Declares debugging assertion reporting functions. More...

class	AttributesFactory
	Creates instances of RegionAttributes. More...

class	AttributesMutator
	Supports modification of certain region attributes after the region has been created. More...

class	AuthInitialize
	Specifies the mechanism to obtain credentials for a client. More...

class	BooleanArray
	An immutable wrapper for array of booleans that can serve as a distributable object for caching. More...

class	Cache
	Cache are obtained from create method on the CacheFactory#create class. More...

class	CacheableArrayList
	A mutable `Cacheable` array list wrapper that can serve as a distributable object for caching. More...

class	CacheableArrayType
	Template class for array of primitive types. More...

class	CacheableBoolean
	An immutable wrapper for booleans that can serve as a distributable key object for caching. More...

class	CacheableByte
	An immutable wrapper for bytes that can serve as a distributable key object for caching. More...

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

class	CacheableContainerType
	Template class for container Cacheable types. More...

class	CacheableDate
	Implement a date object based on system epoch that can serve as a distributable key object for caching as well as being a date value. More...

class	CacheableDouble
	An immutable wrapper for doubles that can serve as a distributable key object for caching. More...

class	CacheableDoubleArray
	An immutable wrapper for array of doubles that can serve as a distributable object for caching. More...

class	CacheableEnum
	Since C++ enums cannot be directly passed as a parameter to PdxWriter's writeObject and PdxReader's readObject api wrap C++ enum in to a immutable wrapper CacheableEnum class type by specifying enum class name, enum value name and its ordinal. More...

class	CacheableFileName
	Implement an immutable wrapper for filenames that can serve as a distributable filename object for caching as both key and value. More...

class	CacheableFloat
	An immutable wrapper for floats that can serve as a distributable key object for caching. More...

class	CacheableFloatArray
	An immutable wrapper for array of floats that can serve as a distributable object for caching. More...

class	CacheableHashMap
	A mutable `CacheableKey` to `Serializable` hash map that can serve as a distributable object for caching. More...

class	CacheableHashSet
	A mutable `CacheableKey` hash set wrapper that can serve as a distributable object for caching. More...

class	CacheableHashTable
	A mutable `CacheableKey` to `Serializable` hash map that can serve as a distributable object for caching. More...

class	CacheableIdentityHashMap
	A mutable `CacheableKey` to `Serializable` hash map that can serve as a distributable object for caching. More...

class	CacheableInt16
	An immutable wrapper for 16-bit integers that can serve as a distributable key object for caching. More...

class	CacheableInt16Array
	An immutable wrapper for array of 16-bit integers that can serve as a distributable object for caching. More...

class	CacheableInt32
	An immutable wrapper for 32-bit integers that can serve as a distributable key object for caching. More...

class	CacheableInt32Array
	An immutable wrapper for array of 32-bit integers that can serve as a distributable object for caching. More...

class	CacheableInt64
	An immutable wrapper for 64-bit integers that can serve as a distributable key object for caching. More...

class	CacheableInt64Array
	An immutable wrapper for array of 64-bit integers that can serve as a distributable object for caching. More...

class	CacheableKey
	Represents a cacheable key. More...

class	CacheableKeyType
	Template CacheableKey class for primitive types. More...

class	CacheableLinkedHashSet
	A mutable `CacheableKey` hash set wrapper that can serve as a distributable object for caching. More...

class	CacheableLinkedList
	A mutable `Cacheable` array list wrapper that can serve as a distributable object for caching. More...

class	CacheableObjectArray
	Implement an immutable Vector of `Cacheable` objects that can serve as a distributable object for caching. More...

class	CacheableStack
	A mutable `Cacheable` stack wrapper that can serve as a distributable object for caching. More...

class	CacheableString
	Implement a immutable C string wrapper that can serve as a distributable key object for caching as well as being a string value. More...

class	CacheableStringArray
	An immutable wrapper for array of strings that can serve as a distributable object for caching. More...

class	CacheableUndefined
	Encapsulate an undefined query result. More...

class	CacheableVector
	A mutable `Cacheable` vector wrapper that can serve as a distributable object for caching. More...

class	CacheableWideChar
	An immutable wrapper for wide-characters that can serve as a distributable key object for caching. More...

class	CacheAttributes
	Defines attributes for configuring a cache. More...

class	CacheAttributesFactory
	Creates instances of `CacheAttributes`. More...

class	CacheFactory
	Top level class for configuring and using GemFire on a client.This should be called once to create Cache. More...

class	CacheListener
	An application plug-in that can be installed on a region. More...

class	CacheLoader
	An application plug-in that can be installed on a region. More...

class	CacheStatistics
	Defines common statistical information for both the region and its entries. More...

class	CacheWriter
	An application plug-in that can be installed on the region. More...

class	CharArray
	An immutable wrapper for array of wide-characters that can serve as a distributable object for caching. More...

class	CqAttributes
	This interface holds all attribute values for a CQ and provides methods for retrieving all attribute settings. More...

class	CqAttributesFactory
	The factory class for the CqAttributes instance. More...

class	CqAttributesMutator
	This interface is used to modify the listeners that are associated with a CQ. More...

class	CqEvent
	This interface provides methods to get all the information sent from the server about the CQ event. More...

class	CqListener
	Application plug-in interface for handling continuous query events after they occur. More...

class	CqQuery
	A Query is obtained from a QueryService which in turn is obtained from the Cache. More...

class	CqResults
	A CqResults is obtained by executing a Query on the server. More...

class	CqServiceStatistics
	This class provides methods to get aggregate statistical information about the CQs of a client. More...

class	CqState
	This interface gives information on the state of a CqQuery. More...

class	CqStatistics
	This class provides methods to get statistical information about a registered Continuous Query (CQ) represented by the CqQuery object. More...

class	CqStatusListener
	Extension of CqListener. More...

class	DataInput
	Provide operations for reading primitive data values, byte arrays, strings, `Serializable` objects from a byte stream. More...

class	DataOutput
	Provide operations for writing primitive data values, byte arrays, strings, `Serializable` objects to a byte stream. More...

class	Delta
	This interface is used for delta propagation. More...

class	DiskPolicyType
	Enumerated type for disk policy. More...

class	DistributedSystem
	DistributedSystem encapsulates this applications "connection" into the GemFire Java servers distributed system. More...

class	EntryEvent
	Represents an entry event affecting an entry, including its identity and the the circumstances of the event. More...

class	Exception
	A description of an exception that occurred during a cache operation. More...

class	Execution
	gathers results from function execution More...

class	ExpirationAction
	Enumerated type for expiration actions. More...

class	FixedPartitionResolver
	Implementers of interface `FixedPartitionResolver` helps to achieve explicit mapping of a "user defined" partition to a data member node. More...

class	FunctionService
	entry point for function execution More...

class	GemFireCache
	GemFireCache represents the singleton cache that must be created in order to connect to Gemfire server. More...

class	HashMapOfCacheable
	A map of `CacheableKey` objects to `Cacheable` that also extends `SharedBase` for smart pointers. More...

class	HashMapOfException
	A map of `CacheableKey` objects to `Exception` that also extends `SharedBase` for smart pointers. More...

class	HashMapOfSharedBase
	Represents a HashMap of `SharedBase` More...

class	HashMapT
	HashMap of `TKEY` to `TVAL`. More...

class	HashSetOfCacheableKey
	A hash set of `CacheableKey` objects that also extends `SharedBase` for smart pointers. More...

class	HashSetOfSharedBase
	Represents a HashSet of `SharedBase` More...

class	HashSetT
	HashSet of `TKEY`. More...

class	InternalCacheTransactionManager2PC
	Extension of the gemfire::CacheTransactionManager that enables client application to use Gemfire transaction as part of the global XA transaction. More...

class	Log
	Defines methods available to clients that want to write a log message to their GemFire system's shared log file. More...

class	LogVarargs
	These functions are added to facilitate logging in printf format. More...

class	NullSharedBase
	Class encapsulating a NULL SharedBase smart pointer. More...

class	PartitionResolver
	Implementers of interface `PartitionResolver` enable custom partitioning on the `PartitionedRegion`. More...

class	PdxInstance
	PdxInstance provides run time access to the fields of a PDX without deserializing the PDX. More...

class	PdxInstanceFactory
	PdxInstanceFactory gives you a way to create PdxInstances. More...

class	PdxReader
	A PdxReader will be passed to PdxSerializable.fromData or during deserialization of a PDX. More...

class	PdxUnreadFields
	Marker interface for an object that GemFire creates and returns from readUnreadFields. More...

class	PdxWriter
	A PdxWriter will be passed to PdxSerializable.toData when it is serializing the domain class. More...

class	PersistenceManager
	PersistenceManager API for persistence and overflow. More...

class	Pool
	A pool of connections to connect from a client to a set of GemFire Cache Servers. More...

class	PoolFactory
	This interface provides for the configuration and creation of instances of Pool. More...

class	PoolManager
	Manages creation and access to connection pools for clients. More...

class	Properties
	Contains a set of (key, value) pair properties with key being the name of the property; value, the value of the property. More...

class	Query
	A Query is obtained from a QueryService which in turn is obtained from the Cache. More...

class	QueryService
	QueryService is the class obtained from a Cache. More...

class	Region
	This class manages subregions and cached data. More...

class	RegionAttributes
	Defines attributes for configuring a region. More...

class	RegionEntry
	An object in a Region that represents an entry, i.e., a key-value pair. More...

class	RegionEvent
	Declares region events. More...

class	RegionService
	A RegionService provides access to existing regions that exist in a GemFire cache. More...

class	ResultCollector
	Defines the interface for a container that gathers results from function execution. More...

class	ResultSet
	A ResultSet may be obtained after executing a Query which is obtained from a QueryService which in turn is obtained from a Cache. More...

class	ScopeType
	Enumerated type for region distribution scope. More...

class	SelectResults
	A SelectResults is obtained by executing a Query on the server. More...

class	SelectResultsIterator
	A SelectResultsIterator is obtained from a ResultSet or StructSet and is used to iterate over the items available in them. More...

class	Serializable
	This abstract base class is the superclass of all user objects in the cache that can be serialized. More...

class	SharedArrayPtr
	Template class for CacheableArrayType SharedPtr's that adds [] operator. More...

class	SharedBase
	This abstract base class is the base class of all user objects that have the shared capability of reference counting. More...

class	SharedPtr
	Defines a reference counted shared pointer. More...

class	SignalHandler
	Represents a signal handler used for dumping stacks and attaching a debugger. More...

class	SPEHelper
	Helper class for SharedPtr exceptions. More...

class	Struct
	A Struct has a StructSet as its parent. More...

class	StructSet
	A StructSet may be obtained after executing a Query which is obtained from a QueryService which in turn is obtained from a Cache. More...

class	SystemProperties
	A class for internal use, that encapsulates the properties that can be set from DistributedSystem::connect. More...

class	TransactionId
	The TransactionId interface is a "marker" interface that represents a unique GemFire transaction. More...

class	UserFunctionExecutionException
	UserFunctionExecutionException class is used to encapsulate gemfire sendException in case of Function execution. More...

class	VectorOfCacheable
	A vector of `Cacheable` objects that also extends `SharedBase` for smart pointers. More...

class	VectorOfCacheableKey
	A vector of `CacheableKey` objects that also extends `SharedBase` for smart pointers. More...

class	VectorOfSharedBase
	Represents a vector of `gemfire::SharedBasePtr` More...

class	VectorT
	Vector template type class. More...

class	WritablePdxInstance
	WritablePdxInstance is a PdxInstance that also supports field modification using the setField method. More...

Typedefs
typedef bool(*	EqualTo) (const SharedBasePtr &, const SharedBasePtr &)
	typedef for the hashing key equality function. More...

typedef int32_t(*	Hasher) (const SharedBasePtr &)
	typedef for the hash function used by the hashing schemes. More...

typedef AuthInitialize (	LibraryAuthInitializeFn) (const char assemblyPath, const char factFuncName)
	The SystemProperties class. More...

typedef Serializable (	TypeFactoryMethod) ()
	signature of functions passed to registerType. More...

typedef void(*	UserDeallocator) (void , const char )
	Function pointer type which takes a void pointer to an instance of a user object to delete and class name. More...

typedef uint32_t(*	UserObjectSizer) (void , const char )
	Function pointer type which takes a void pointer to an instance of a user object and class name to return the size of the user object. More...

Enumerations

Functions
template<typename TObj >
void	copyArray (TObj dest, const TObj src, int32_t length)
	Function to copy an array from source to destination. More...

template<typename TObj >
void	copyArray (SharedPtr< TObj > dest, const SharedPtr< TObj > src, int32_t length)
	Function to copy an array of `SharedPtr`s from source to destination. More...

template<typename TObj , int8_t TYPEID>
void	copyArray (SharedArrayPtr< TObj, TYPEID > dest, const SharedArrayPtr< TObj, TYPEID > src, int32_t length)
	Function to copy an array of `SharedArrayPtr`s from source to destination. More...

CacheableKeyPtr	createKeyArr (const char *value)
	overload of gemfire::createKeyArr to pass char* More...

CacheableKeyPtr	createKeyArr (const wchar_t *value)
	overload of gemfire::createKeyArr to pass wchar_t* More...

CacheablePtr	createValueArr (const char *value)
	overload of gemfire::createValueArr to pass char* More...

CacheablePtr	createValueArr (const wchar_t *value)
	overload of gemfire::createValueArr to pass wchar_t* More...

template<class TargetSP , class Other >
TargetSP	dynCast (const SharedPtr< Other > &other)
	Dynamically cast the underlying pointer to the given type and throw `ClassCastException` if the cast fails. More...

int	gf_snprintf (char buffer, int32_t maxLength, const char fmt,...)
	snprintf implementation. More...

int	gf_sprintf (char buffer, const char fmt,...)
	sprintf implementation. More...

void CPPCACHE_EXPORT	GfErrTypeThrowException (const char *str, GfErrType err)
	Thrown when a version on which delta is based is different than the current version. More...

template<class TargetSP , class Other >
bool	instanceOf (const SharedPtr< Other > &other)
	Dynamically check if the underlying pointer is of the given SharedPtr type. More...

template<class TargetSP , class Other >
TargetSP	staticCast (const SharedPtr< Other > &other)
	Statically cast the underlying pointer to the given type. More...

Variables
const char	_exception_name_AllConnectionsInUseException [] = "gemfire::" "AllConnectionsInUseException"
	Thrown if all connections in the pool are in use. More...

const char	_exception_name_AlreadyConnectedException [] = "gemfire::" "AlreadyConnectedException"
	Thrown when an attempt is made to connect to DistributedSystem second time. More...

const char	_exception_name_AssertionException [] = "gemfire::" "AssertionException"
	A gemfire assertion exception. More...

const char	_exception_name_AuthenticationFailedException [] = "gemfire::" "AuthenticationFailedException"
	Thrown when authentication fails. More...

const char	_exception_name_AuthenticationRequiredException [] = "gemfire::" "AuthenticationRequiredException"
	Thrown when no credentials are provided by client when server expects. More...

const char	_exception_name_BufferSizeExceededException [] = "gemfire::" "BufferSizeExceededException"
	Thrown when the internal buffer size is exceeded. More...

const char	_exception_name_CacheClosedException [] = "gemfire::" "CacheClosedException"
	Thrown when an operation is attempted on a closed cache. More...

const char	_exception_name_CacheExistsException [] = "gemfire::" "CacheExistsException"
	Thrown when an attempt is made to create an existing cache. More...

const char	_exception_name_CacheListenerException [] = "gemfire::" "CacheListenerException"
	Thrown when the cache listener throws an exception. More...

const char	_exception_name_CacheLoaderException [] = "gemfire::" "CacheLoaderException"
	Thrown when the cache loader aborts the operation. More...

const char	_exception_name_CacheProxyException [] = "gemfire::" "CacheProxyException"
	Thrown when there is an error in the cache proxy. More...

const char	_exception_name_CacheServerException [] = "gemfire::" "CacheServerException"
	Thrown when an exception occurs on the cache server. More...

const char	_exception_name_CacheWriterException [] = "gemfire::" "CacheWriterException"
	Thrown when the cache writer aborts the operation. More...

const char	_exception_name_CacheXmlException [] = "gemfire::" "CacheXmlException"
	Thrown when the cache xml is incorrect. More...

const char	_exception_name_ClassCastException [] = "gemfire::" "ClassCastException"
	Thrown when a cast operation fails. More...

const char	_exception_name_CommitConflictException [] = "gemfire::" "CommitConflictException"
	Thrown when a commit fails due to a write conflict. More...

const char	_exception_name_ConcurrentModificationException [] = "gemfire::" "ConcurrentModificationException"
	Thrown when a concurrent operation fails. More...

const char	_exception_name_CqClosedException [] = "gemfire::" "CqClosedException"
	Thrown if the Cq on which the operaion performed is closed. More...

const char	_exception_name_CqException [] = "gemfire::" "CqException"
	Thrown during continuous query execution time. More...

const char	_exception_name_CqExistsException [] = "gemfire::" "CqExistsException"
	Thrown if a Cq by this name already exists on this client. More...

const char	_exception_name_CqInvalidException [] = "gemfire::" "CqInvalidException"
	Thrown if the query doesnot meet the CQ constraints. More...

const char	_exception_name_CqQueryException [] = "gemfire::" "CqQueryException"
	Thrown if the Cq Query failed. More...

const char	_exception_name_DiskCorruptException [] = "gemfire::" "DiskCorruptException"
	Thrown by the persistence manager when the data. More...

const char	_exception_name_DiskFailureException [] = "gemfire::" "DiskFailureException"
	Thrown by the persistence manager when a write fails due to disk failure. More...

const char	_exception_name_DuplicateDurableClientException [] = "gemfire::" "DuplicateDurableClientException"
	Thrown when two durable connect with same Id. More...

const char	_exception_name_EntryDestroyedException [] = "gemfire::" "EntryDestroyedException"
	Thrown when an operation is attempted on a destroyed entry. More...

const char	_exception_name_EntryExistsException [] = "gemfire::" "EntryExistsException"
	Thrown when attempt is made to create an existing entry. More...

const char	_exception_name_EntryNotFoundException [] = "gemfire::" "EntryNotFoundException"
	Thrown when an operation is attempted on a non-existent entry. More...

const char	_exception_name_FatalInternalException [] = "gemfire::" "FatalInternalException"
	Thrown when there is a fatal internal exception in gemfire. More...

const char	_exception_name_FileNotFoundException [] = "gemfire::" "FileNotFoundException"
	Thrown when a non-existing file is accessed. More...

const char	_exception_name_FunctionExecutionException [] = "gemfire::" "FunctionExecutionException"
	Thrown if function execution failed. More...

const char	_exception_name_GemfireConfigException [] = "gemfire::" "GemfireConfigException"
	Thrown when gemfire configuration file is incorrect. More...

const char	_exception_name_GemfireIOException [] = "gemfire::" "GemfireIOException"
	Thrown when there is an input/output error. More...

const char	_exception_name_IllegalArgumentException [] = "gemfire::" "IllegalArgumentException"
	Thrown when an argument to a method is illegal. More...

const char	_exception_name_IllegalStateException [] = "gemfire::" "IllegalStateException"
	Thrown when the state of cache is manipulated to be illegal. More...

const char	_exception_name_InitFailedException [] = "gemfire::" "InitFailedException"
	Thrown when persistence manager fails to initialize. More...

const char	_exception_name_InterruptedException [] = "gemfire::" "InterruptedException"
	Thrown when an operation is interrupted. More...

const char	_exception_name_InvalidDeltaException [] = "gemfire::" "InvalidDeltaException"
	Thrown if Delta could not be applied. More...

const char	_exception_name_KeyNotFoundException [] = "gemfire::" "KeyNotFoundException"
	Thrown if a Key is not present in the region. More...

const char	_exception_name_LeaseExpiredException [] = "gemfire::" "LeaseExpiredException"
	Thrown when lease of cache proxy has expired. More...

const char	_exception_name_MessageException [] = "gemfire::" "MessageException"
	Thrown when an unknown message is received from the server. More...

const char	_exception_name_NoAvailableLocatorsException [] = "gemfire::" "NoAvailableLocatorsException"
	Thrown if the No locators are active to reply for new connection. More...

const char	_exception_name_NoSystemException [] = "gemfire::" "NoSystemException"
	Thrown when the connecting target is not running. More...

const char	_exception_name_NotAuthorizedException [] = "gemfire::" "NotAuthorizedException"
	Thrown when a non authorized operation is done. More...

const char	_exception_name_NotConnectedException [] = "gemfire::" "NotConnectedException"
	Thrown when an operation is attempted before connecting to the distributed system. More...

const char	_exception_name_NotOwnerException [] = "gemfire::" "NotOwnerException"
	Thrown when an attempt is made to release a lock not owned by the thread. More...

const char	_exception_name_NullPointerException [] = "gemfire::" "NullPointerException"
	Thrown when a null argument is provided to a method where it is expected to be non-null. More...

const char	_exception_name_OutOfMemoryException [] = "gemfire::" "OutOfMemoryException"
	Thrown when the system cannot allocate any more memory. More...

const char	_exception_name_OutOfRangeException [] = "gemfire::" "OutOfRangeException"
	Thrown when bound of array/vector etc. More...

const char	_exception_name_PutAllPartialResultException [] = "gemfire::" "PutAllPartialResultException"
	Thrown if putAll operation with single hop succeeded partially. More...

const char	_exception_name_QueryException [] = "gemfire::" "QueryException"
	Thrown when query exception occurs at the server. More...

const char	_exception_name_RegionCreationFailedException [] = "gemfire::" "RegionCreationFailedException"
	Thrown when a region creation operation fails. More...

const char	_exception_name_RegionDestroyedException [] = "gemfire::" "RegionDestroyedException"
	Thrown when an operation is attempted on a destroyed region. More...

const char	_exception_name_RegionExistsException [] = "gemfire::" "RegionExistsException"
	Thrown when an attempt is made to create an existing region. More...

const char	_exception_name_RollbackException [] = "gemfire::" "RollbackException"
	The RollbackException exception indicates that either the transaction has been rolled back or an operation cannot complete because the transaction is marked for rollback only. More...

const char	_exception_name_ShutdownFailedException [] = "gemfire::" "ShutdownFailedException"
	Thrown when persistence manager fails to close properly. More...

const char	_exception_name_StatisticsDisabledException [] = "gemfire::" "StatisticsDisabledException"
	Thrown when statistics are invoked for a region where they are disabled. More...

const char	_exception_name_TimeoutException [] = "gemfire::" "TimeoutException"
	Thrown when a timout occurs. More...

const char	_exception_name_TransactionDataNodeHasDepartedException [] = "gemfire::" "TransactionDataNodeHasDepartedException"
	Thrown when the transactional data host has shutdown or no longer has the data being modified by the transaction. More...

const char	_exception_name_TransactionDataRebalancedException [] = "gemfire::" "TransactionDataRebalancedException"
	Thrown when a RebalanceOperation occurs concurrently with a transaction. More...

const char	_exception_name_TransactionException [] = "gemfire::" "TransactionException"
	This is for all Exceptions that may be thrown by a GemFire transaction. More...

const char	_exception_name_UnknownException [] = "gemfire::" "UnknownException"
	An unknown exception occurred. More...

const char	_exception_name_UnsupportedOperationException [] = "gemfire::" "UnsupportedOperationException"
	Thrown when an operation unsupported by the current configuration is attempted. More...

const char	_exception_name_WrongRegionScopeException [] = "gemfire::" "WrongRegionScopeException"
	Thrown when a region is created in an incorrect scope. More...

Detailed Description

This namespace contains all the GemFire C++ API classes, enumerations and globals.

Each enum represents a predefined RegionAttributes in a Cache.

These enum values can be used to create regions using a RegionFactory obtained by calling Cache#createRegionFactory(RegionShortcut).

Another way to use predefined region attributes is in cache.xml by setting the refid attribute on a region element or region-attributes element to the string of each value.

Typedef Documentation

typedef bool(* gemfire::EqualTo) (const SharedBasePtr &, const SharedBasePtr &)

typedef for the hashing key equality function.

typedef int32_t(* gemfire::Hasher) (const SharedBasePtr &)

typedef for the hash function used by the hashing schemes.

typedef AuthInitialize*( * gemfire::LibraryAuthInitializeFn) (const char *assemblyPath, const char *factFuncName)

The SystemProperties class.

Author: Neeraj Kumar

typedef Serializable*( * gemfire::TypeFactoryMethod) ()

signature of functions passed to registerType.

Such functions should return an empty instance of the type they represent. The instance will typically be initialized immediately after creation by a call to fromData().

typedef void(* gemfire::UserDeallocator) (void *, const char *)

Function pointer type which takes a void pointer to an instance of a user object to delete and class name.

typedef uint32_t(* gemfire::UserObjectSizer) (void *, const char *)

Function pointer type which takes a void pointer to an instance of a user object and class name to return the size of the user object.

Enumeration Type Documentation

enum gemfire::RegionShortcut

Enumerator
PROXY	A PROXY region has no local state and forwards all operations to a server.
CACHING_PROXY	A CACHING_PROXY region has local state but can also send operations to a server. If the local state is not found then the operation is sent to the server and the local state is updated to contain the server result.
CACHING_PROXY_ENTRY_LRU	A CACHING_PROXY_LRU region has local state but can also send operations to a server. If the local state is not found then the operation is sent to the server and the local state is updated to contain the server result. It will also destroy entries once it detects that the number of enteries crossing default limit of #100000.
LOCAL	A LOCAL region only has local state and never sends operations to a server.
LOCAL_ENTRY_LRU	A LOCAL_LRU region only has local state and never sends operations to a server. It will also destroy entries once it detects that the number of enteries crossing default limit of #100000.

Function Documentation

template<typename TObj >

void gemfire::copyArray	(	TObj *	dest,
		const TObj *	src,
		int32_t	length
	)

inline

Function to copy an array from source to destination.

template<typename TObj >

void gemfire::copyArray	(	SharedPtr< TObj > *	dest,
		const SharedPtr< TObj > *	src,
		int32_t	length
	)

inline

Function to copy an array of SharedPtrs from source to destination.

template<typename TObj , int8_t TYPEID>

void gemfire::copyArray	(	SharedArrayPtr< TObj, TYPEID > *	dest,
		const SharedArrayPtr< TObj, TYPEID > *	src,
		int32_t	length
	)

inline

Function to copy an array of SharedArrayPtrs from source to destination.

CacheableKeyPtr gemfire::createKeyArr ( const char * value )

inline

overload of gemfire::createKeyArr to pass char*

CacheableKeyPtr gemfire::createKeyArr ( const wchar_t * value )

inline

overload of gemfire::createKeyArr to pass wchar_t*

CacheablePtr gemfire::createValueArr ( const char * value )

inline

overload of gemfire::createValueArr to pass char*

CacheablePtr gemfire::createValueArr ( const wchar_t * value )

inline

overload of gemfire::createValueArr to pass wchar_t*

template<class TargetSP , class Other >

TargetSP gemfire::dynCast ( const SharedPtr< Other > & other )

Dynamically cast the underlying pointer to the given type and throw ClassCastException if the cast fails.

int gemfire::gf_snprintf	(	char *	buffer,
		int32_t	maxLength,
		const char *	fmt,
			...
	)

snprintf implementation.

int gemfire::gf_sprintf	(	char *	buffer,
		const char *	fmt,
			...
	)

sprintf implementation.

void CPPCACHE_EXPORT gemfire::GfErrTypeThrowException	(	const char *	str,
		GfErrType	err
	)

Thrown when a version on which delta is based is different than the current version.

template<class TargetSP , class Other >

bool gemfire::instanceOf ( const SharedPtr< Other > & other )

Dynamically check if the underlying pointer is of the given SharedPtr type.

template<class TargetSP , class Other >

TargetSP gemfire::staticCast ( const SharedPtr< Other > & other )

Statically cast the underlying pointer to the given type.

The behaviour is similar to static_cast.

Make use of this cast with care since it does not offer protection against incorrect casts. For most purposes dynCast is the better choice and this should be used only where the programmer knows the cast to be safe.

Setting the macro GF_DEBUG_ASSERTS enables dynamic checking of the cast throwing an AssertionException if the cast fails.

Variable Documentation

const char gemfire::_exception_name_AllConnectionsInUseException[] = "gemfire::" "AllConnectionsInUseException"

Thrown if all connections in the pool are in use.

const char gemfire::_exception_name_AlreadyConnectedException[] = "gemfire::" "AlreadyConnectedException"

Thrown when an attempt is made to connect to DistributedSystem second time.

const char gemfire::_exception_name_AssertionException[] = "gemfire::" "AssertionException"

A gemfire assertion exception.

const char gemfire::_exception_name_AuthenticationFailedException[] = "gemfire::" "AuthenticationFailedException"

Thrown when authentication fails.

const char gemfire::_exception_name_AuthenticationRequiredException[] = "gemfire::" "AuthenticationRequiredException"

Thrown when no credentials are provided by client when server expects.

const char gemfire::_exception_name_BufferSizeExceededException[] = "gemfire::" "BufferSizeExceededException"

Thrown when the internal buffer size is exceeded.

const char gemfire::_exception_name_CacheClosedException[] = "gemfire::" "CacheClosedException"

Thrown when an operation is attempted on a closed cache.

const char gemfire::_exception_name_CacheExistsException[] = "gemfire::" "CacheExistsException"

Thrown when an attempt is made to create an existing cache.

const char gemfire::_exception_name_CacheListenerException[] = "gemfire::" "CacheListenerException"

Thrown when the cache listener throws an exception.

const char gemfire::_exception_name_CacheLoaderException[] = "gemfire::" "CacheLoaderException"

Thrown when the cache loader aborts the operation.

const char gemfire::_exception_name_CacheProxyException[] = "gemfire::" "CacheProxyException"

Thrown when there is an error in the cache proxy.

const char gemfire::_exception_name_CacheServerException[] = "gemfire::" "CacheServerException"

Thrown when an exception occurs on the cache server.

const char gemfire::_exception_name_CacheWriterException[] = "gemfire::" "CacheWriterException"

Thrown when the cache writer aborts the operation.

const char gemfire::_exception_name_CacheXmlException[] = "gemfire::" "CacheXmlException"

Thrown when the cache xml is incorrect.

const char gemfire::_exception_name_ClassCastException[] = "gemfire::" "ClassCastException"

Thrown when a cast operation fails.

const char gemfire::_exception_name_CommitConflictException[] = "gemfire::" "CommitConflictException"

Thrown when a commit fails due to a write conflict.

See also: CacheTransactionManager::commit

const char gemfire::_exception_name_ConcurrentModificationException[] = "gemfire::" "ConcurrentModificationException"

Thrown when a concurrent operation fails.

const char gemfire::_exception_name_CqClosedException[] = "gemfire::" "CqClosedException"

Thrown if the Cq on which the operaion performed is closed.

const char gemfire::_exception_name_CqException[] = "gemfire::" "CqException"

Thrown during continuous query execution time.

const char gemfire::_exception_name_CqExistsException[] = "gemfire::" "CqExistsException"

Thrown if a Cq by this name already exists on this client.

const char gemfire::_exception_name_CqInvalidException[] = "gemfire::" "CqInvalidException"

Thrown if the query doesnot meet the CQ constraints.

E.g.:Query string should refer only one region, join not supported. The query must be a SELECT statement. DISTINCT queries are not supported. Projections are not supported. Only one iterator in the FROM clause is supported, and it must be a region path. Bind parameters in the query are not supported for the initial release.

const char gemfire::_exception_name_CqQueryException[] = "gemfire::" "CqQueryException"

Thrown if the Cq Query failed.

const char gemfire::_exception_name_DiskCorruptException[] = "gemfire::" "DiskCorruptException"

Thrown by the persistence manager when the data.

to be read from disk is corrupt.

const char gemfire::_exception_name_DiskFailureException[] = "gemfire::" "DiskFailureException"

Thrown by the persistence manager when a write fails due to disk failure.

const char gemfire::_exception_name_DuplicateDurableClientException[] = "gemfire::" "DuplicateDurableClientException"

Thrown when two durable connect with same Id.

const char gemfire::_exception_name_EntryDestroyedException[] = "gemfire::" "EntryDestroyedException"

Thrown when an operation is attempted on a destroyed entry.

const char gemfire::_exception_name_EntryExistsException[] = "gemfire::" "EntryExistsException"

Thrown when attempt is made to create an existing entry.

const char gemfire::_exception_name_EntryNotFoundException[] = "gemfire::" "EntryNotFoundException"

Thrown when an operation is attempted on a non-existent entry.

const char gemfire::_exception_name_FatalInternalException[] = "gemfire::" "FatalInternalException"

Thrown when there is a fatal internal exception in gemfire.

const char gemfire::_exception_name_FileNotFoundException[] = "gemfire::" "FileNotFoundException"

Thrown when a non-existing file is accessed.

const char gemfire::_exception_name_FunctionExecutionException[] = "gemfire::" "FunctionExecutionException"

Thrown if function execution failed.

const char gemfire::_exception_name_GemfireConfigException[] = "gemfire::" "GemfireConfigException"

Thrown when gemfire configuration file is incorrect.

const char gemfire::_exception_name_GemfireIOException[] = "gemfire::" "GemfireIOException"

Thrown when there is an input/output error.

const char gemfire::_exception_name_IllegalArgumentException[] = "gemfire::" "IllegalArgumentException"

Thrown when an argument to a method is illegal.

const char gemfire::_exception_name_IllegalStateException[] = "gemfire::" "IllegalStateException"

Thrown when the state of cache is manipulated to be illegal.

const char gemfire::_exception_name_InitFailedException[] = "gemfire::" "InitFailedException"

Thrown when persistence manager fails to initialize.

const char gemfire::_exception_name_InterruptedException[] = "gemfire::" "InterruptedException"

Thrown when an operation is interrupted.

const char gemfire::_exception_name_InvalidDeltaException[] = "gemfire::" "InvalidDeltaException"

Thrown if Delta could not be applied.

const char gemfire::_exception_name_KeyNotFoundException[] = "gemfire::" "KeyNotFoundException"

Thrown if a Key is not present in the region.

const char gemfire::_exception_name_LeaseExpiredException[] = "gemfire::" "LeaseExpiredException"

Thrown when lease of cache proxy has expired.

const char gemfire::_exception_name_MessageException[] = "gemfire::" "MessageException"

Thrown when an unknown message is received from the server.

const char gemfire::_exception_name_NoAvailableLocatorsException[] = "gemfire::" "NoAvailableLocatorsException"

Thrown if the No locators are active to reply for new connection.

const char gemfire::_exception_name_NoSystemException[] = "gemfire::" "NoSystemException"

Thrown when the connecting target is not running.

const char gemfire::_exception_name_NotAuthorizedException[] = "gemfire::" "NotAuthorizedException"

Thrown when a non authorized operation is done.

const char gemfire::_exception_name_NotConnectedException[] = "gemfire::" "NotConnectedException"

Thrown when an operation is attempted before connecting to the distributed system.

const char gemfire::_exception_name_NotOwnerException[] = "gemfire::" "NotOwnerException"

Thrown when an attempt is made to release a lock not owned by the thread.

const char gemfire::_exception_name_NullPointerException[] = "gemfire::" "NullPointerException"

Thrown when a null argument is provided to a method where it is expected to be non-null.

const char gemfire::_exception_name_OutOfMemoryException[] = "gemfire::" "OutOfMemoryException"

Thrown when the system cannot allocate any more memory.

const char gemfire::_exception_name_OutOfRangeException[] = "gemfire::" "OutOfRangeException"

Thrown when bound of array/vector etc.

is exceeded.

const char gemfire::_exception_name_PutAllPartialResultException[] = "gemfire::" "PutAllPartialResultException"

Thrown if putAll operation with single hop succeeded partially.

const char gemfire::_exception_name_QueryException[] = "gemfire::" "QueryException"

Thrown when query exception occurs at the server.

const char gemfire::_exception_name_RegionCreationFailedException[] = "gemfire::" "RegionCreationFailedException"

Thrown when a region creation operation fails.

const char gemfire::_exception_name_RegionDestroyedException[] = "gemfire::" "RegionDestroyedException"

Thrown when an operation is attempted on a destroyed region.

const char gemfire::_exception_name_RegionExistsException[] = "gemfire::" "RegionExistsException"

Thrown when an attempt is made to create an existing region.

const char gemfire::_exception_name_RollbackException[] = "gemfire::" "RollbackException"

The RollbackException exception indicates that either the transaction has been rolled back or an operation cannot complete because the transaction is marked for rollback only.

const char gemfire::_exception_name_ShutdownFailedException[] = "gemfire::" "ShutdownFailedException"

Thrown when persistence manager fails to close properly.

const char gemfire::_exception_name_StatisticsDisabledException[] = "gemfire::" "StatisticsDisabledException"

Thrown when statistics are invoked for a region where they are disabled.

const char gemfire::_exception_name_TimeoutException[] = "gemfire::" "TimeoutException"

Thrown when a timout occurs.

const char gemfire::_exception_name_TransactionDataNodeHasDepartedException[] = "gemfire::" "TransactionDataNodeHasDepartedException"

Thrown when the transactional data host has shutdown or no longer has the data being modified by the transaction.

This can be thrown while doing transactional operations or during commit.

const char gemfire::_exception_name_TransactionDataRebalancedException[] = "gemfire::" "TransactionDataRebalancedException"

Thrown when a RebalanceOperation occurs concurrently with a transaction.

This can be thrown while doing transactional operations or during commit.

const char gemfire::_exception_name_TransactionException[] = "gemfire::" "TransactionException"

This is for all Exceptions that may be thrown by a GemFire transaction.

const char gemfire::_exception_name_UnknownException[] = "gemfire::" "UnknownException"

An unknown exception occurred.

const char gemfire::_exception_name_UnsupportedOperationException[] = "gemfire::" "UnsupportedOperationException"

Thrown when an operation unsupported by the current configuration is attempted.

const char gemfire::_exception_name_WrongRegionScopeException[] = "gemfire::" "WrongRegionScopeException"

Thrown when a region is created in an incorrect scope.

Namespaces

Data Structures

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation