Pivotal GemFire Native Client Cache Reference  9.0.6
gf_base.hpp File Reference

Definitions of types and functions supported in the GemFire C++ interface. More...

Go to the source code of this file.

Namespaces

 gemfire
 This namespace contains all the GemFire C++ API classes, enumerations and globals.
 
 gemfire::TypeHelper
 This namespace contains type traits helper structs/classes to determine type information at compile time using typename.
 
 gemfire_statistics
 This namespace contains all the GemFire C++ statistics API classes.
 

Macros

#define CPPCACHE_EXPORT
 Defines a GemFire CPPCACHE export. More...
 
#define DEFAULT_QUERY_RESPONSE_TIMEOUT   15
 default timeout for query response More...
 
#define GF_NEW(v, stmt)
 Allocates x and throws OutOfMemoryException if it fails. More...
 
#define GF_SAFE_DELETE(x)
 Deletes x only if it exists. More...
 
#define GF_SAFE_DELETE_ARRAY(x)
 Deletes array x only if it exists. More...
 
#define GF_TEMPLATE_EXPORT
 Define GF_TEMPLATE_EXPORT. More...
 
#define GFCEXTERN(type)   LIBIMP type LIBCALL
 Defines a GemFire C extern. More...
 
#define LIBCALL
 Library Call. More...
 
#define LIBEXP
 Library Export. More...
 
#define LIBEXPORT(type)   type
 Library Export a type. More...
 
#define LIBIMP   extern
 Library Implementation. More...
 

Typedefs

typedef int16_t int16
 signed 16 bit integer (short) More...
 
typedef int32_t int32
 signed 32 bit integer More...
 
typedef int64_t int64
 signed 64 bit integer More...
 
typedef int8_t int8
 single byte, character or boolean field More...
 
typedef uint16_t uint16
 unsigned 16 bit integer (ushort) More...
 
typedef uint32_t uint32
 unsigned 32 bit integer More...
 
typedef uint64_t uint64
 unsigned 64 bit integer More...
 
typedef uint8_t uint8
 unsigned integer value More...
 

Enumerations

Detailed Description

Definitions of types and functions supported in the GemFire C++ interface.

Macro Definition Documentation

#define CPPCACHE_EXPORT

Defines a GemFire CPPCACHE export.

#define DEFAULT_QUERY_RESPONSE_TIMEOUT   15

default timeout for query response

#define GF_NEW (   v,
  stmt 
)
Value:
{ \
try { \
v = new stmt; \
} \
catch (const std::bad_alloc&) { \
throw gemfire::OutOfMemoryException( \
"Out of Memory while executing \""#v" = new "#stmt";\""); \
} \
}

Allocates x and throws OutOfMemoryException if it fails.

#define GF_SAFE_DELETE (   x)
Value:
{ \
delete x; \
x = NULL; \
}

Deletes x only if it exists.

#define GF_SAFE_DELETE_ARRAY (   x)
Value:
{ \
delete [ ] x; \
x = NULL; \
}

Deletes array x only if it exists.

#define GF_TEMPLATE_EXPORT

Define GF_TEMPLATE_EXPORT.

#define GFCEXTERN (   type)    LIBIMP type LIBCALL

Defines a GemFire C extern.

#define LIBCALL

Library Call.

#define LIBEXP

Library Export.

#define LIBEXPORT (   type)    type

Library Export a type.

#define LIBIMP   extern

Library Implementation.

Typedef Documentation

typedef int16_t int16

signed 16 bit integer (short)

typedef int32_t int32

signed 32 bit integer

typedef int64_t int64

signed 64 bit integer

typedef int8_t int8

single byte, character or boolean field

typedef uint16_t uint16

unsigned 16 bit integer (ushort)

typedef uint32_t uint32

unsigned 32 bit integer

typedef uint64_t uint64

unsigned 64 bit integer

typedef uint8_t uint8

unsigned integer value

Enumeration Type Documentation

enum GfErrType

Error codes returned by GemFire C++ interface functions.

Enumerator
GF_NOERR 

success - no error

GF_DEADLK 

deadlock detected

GF_EACCES 

permission problem

GF_ECONFL 

class creation conflict

GF_EINVAL 

invalid argument

GF_ENOENT 

entity does not exist

GF_ENOMEM 

insufficient memory

GF_ERANGE 

index out of range

GF_ETYPE 

type mismatch

GF_NOTOBJ 

invalid object reference

GF_NOTCON 

not connected to GemFire

GF_NOTOWN 

lock not owned by process/thread

GF_NOTSUP 

operation not supported

GF_SCPGBL 

attempt to exit global scope

GF_SCPEXC 

maximum scopes exceeded

GF_TIMOUT 

operation timed out

GF_OVRFLW 

arithmetic overflow

GF_IOERR 

paging file I/O error

GF_EINTR 

interrupted GemFire call

GF_MSG 

message could not be handled

GF_DISKFULL 

disk full

GF_SERVER_FAILED 

NoServer found.

GF_CACHE_REGION_NOT_FOUND 

No region with the specified name.

GF_CACHE_REGION_INVALID 

the region is not valid

GF_CACHE_REGION_KEYS_NOT_STRINGS 

Entry keys are not strings.

GF_CACHE_REGION_ENTRY_NOT_BYTES 

Entry's value is not a byte array.

GF_CACHE_REGION_NOT_GLOBAL 

Distributed locks not supported.

GF_CACHE_PROXY 

Errors detected in CacheProxy processing.

GF_CACHE_ILLEGAL_ARGUMENT_EXCEPTION 

IllegalArgumentException in Cache Proxy.

GF_CACHE_ILLEGAL_STATE_EXCEPTION 

IllegalStateException in CacheProxy.

GF_CACHE_TIMEOUT_EXCEPTION 

TimeoutException in CacheProxy.

GF_CACHE_WRITER_EXCEPTION 

CacheWriterException in CacheProxy.

GF_CACHE_REGION_EXISTS_EXCEPTION 

RegionExistsException in CacheProxy.

GF_CACHE_CLOSED_EXCEPTION 

CacheClosedException in CacheProxy.

GF_CACHE_LEASE_EXPIRED_EXCEPTION 

LeaseExpiredException in CacheProxy.

GF_CACHE_LOADER_EXCEPTION 

CacheLoaderException in CacheProxy.

GF_CACHE_REGION_DESTROYED_EXCEPTION 

RegionDestroyedException in CacheProxy.

GF_CACHE_ENTRY_DESTROYED_EXCEPTION 

EntryDestroyedException in CacheProxy.

GF_CACHE_STATISTICS_DISABLED_EXCEPTION 

StatisticsDisabledException in CacheProxy.

GF_CACHE_CONCURRENT_MODIFICATION_EXCEPTION 

ConcurrentModificationException in CacheProxy.

GF_CACHE_ENTRY_NOT_FOUND 

EntryNotFoundException in CacheProxy.

GF_CACHE_ENTRY_EXISTS 

EntryExistsException in CacheProxy.

GF_CACHEWRITER_ERROR 

An Exception occured while invoking a cachewritter callback.

GF_CANNOT_PROCESS_GII_REQUEST 

A failure other than timeout occured durring a batch request.

GF_CACHESERVER_EXCEPTION 

Java cache server exception sent to the thin client by java cache server.

GF_AUTHENTICATION_FAILED_EXCEPTION 

Authentication Fails.

GF_NOT_AUTHORIZED_EXCEPTION 

Non Authorized Operation Tried.

GF_DUPLICATE_DURABLE_CLIENT 

No Authentication Provided.

Java cache server refused duplicate durable client

GF_CACHE_LISTENER_EXCEPTION 

Query exception on java cache server.

GF_ALL_CONNECTIONS_IN_USE_EXCEPTION 

Exception in CacheListener.

GF_CACHE_ENTRY_UPDATED 

ALl connections in use.

local entry was updated while a remote modification operation was in progress

GF_INVALID_DELTA 

Exception in Locator.

GF_EUNDEF 

unknown exception


GemFire C++ Cache API Documentation