VMware GemFire Native C++ Reference  9.2.4
geode_base.hpp File Reference

Go to the source code of this file.

Namespaces

 apache::geode::client::TypeHelper
 Helper type traits and other structs/classes to determine type information at compile time using typename.
 
 geode
 
 geode_statistics
 

Macros

#define CPPCACHE_EXPORT
 Defines a Geode 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 Geode 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...
 

Enumerations

enum  GfErrType {
  GF_NOERR = 0, GF_DEADLK = 1, GF_EACCES = 2, GF_ECONFL = 3,
  GF_EINVAL = 4, GF_ENOENT = 5, GF_ENOMEM = 6, GF_ERANGE = 7,
  GF_ETYPE = 8, GF_NOTOBJ = 9, GF_NOTCON = 10, GF_NOTOWN = 11,
  GF_NOTSUP = 12, GF_SCPGBL = 13, GF_SCPEXC = 14, GF_TIMOUT = 15,
  GF_OVRFLW = 16, GF_IOERR = 17, GF_EINTR = 18, GF_MSG = 19,
  GF_DISKFULL = 20 , GF_SERVER_FAILED = 22 , GF_CACHE_REGION_NOT_FOUND = 101, GF_CACHE_REGION_INVALID = 102,
  GF_CACHE_REGION_KEYS_NOT_STRINGS = 103, GF_CACHE_REGION_ENTRY_NOT_BYTES, GF_CACHE_REGION_NOT_GLOBAL = 105, GF_CACHE_PROXY = 106,
  GF_CACHE_ILLEGAL_ARGUMENT_EXCEPTION, GF_CACHE_ILLEGAL_STATE_EXCEPTION, GF_CACHE_TIMEOUT_EXCEPTION = 109, GF_CACHE_WRITER_EXCEPTION = 110,
  GF_CACHE_REGION_EXISTS_EXCEPTION, GF_CACHE_CLOSED_EXCEPTION = 112, GF_CACHE_LEASE_EXPIRED_EXCEPTION, GF_CACHE_LOADER_EXCEPTION = 114,
  GF_CACHE_REGION_DESTROYED_EXCEPTION, GF_CACHE_ENTRY_DESTROYED_EXCEPTION, GF_CACHE_STATISTICS_DISABLED_EXCEPTION, GF_CACHE_CONCURRENT_MODIFICATION_EXCEPTION,
  GF_CACHE_ENTRY_NOT_FOUND = 119, GF_CACHE_ENTRY_EXISTS = 120, GF_CACHEWRITER_ERROR, GF_CANNOT_PROCESS_GII_REQUEST,
  GF_CACHESERVER_EXCEPTION = 124, GF_AUTHENTICATION_FAILED_EXCEPTION = 126, GF_NOT_AUTHORIZED_EXCEPTION = 127 , GF_DUPLICATE_DURABLE_CLIENT ,
  GF_CACHE_LISTENER_EXCEPTION = 131, GF_ALL_CONNECTIONS_IN_USE_EXCEPTION = 132, GF_CACHE_ENTRY_UPDATED = 133 , GF_INVALID_DELTA = 135 ,
  GF_EUNDEF = 999
}
 

Detailed Description

Definitions of types and functions supported in the Geode C++ interface

Macro Definition Documentation

◆ CPPCACHE_EXPORT

#define CPPCACHE_EXPORT

Defines a Geode CPPCACHE export.

◆ DEFAULT_QUERY_RESPONSE_TIMEOUT

#define DEFAULT_QUERY_RESPONSE_TIMEOUT   15

default timeout for query response

◆ GF_NEW

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

Allocates x and throws OutOfMemoryException if it fails.

◆ GF_SAFE_DELETE

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

Deletes x only if it exists.

◆ GF_SAFE_DELETE_ARRAY

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

Deletes array x only if it exists.

◆ GF_TEMPLATE_EXPORT

#define GF_TEMPLATE_EXPORT

Define GF_TEMPLATE_EXPORT.

◆ GFCEXTERN

#define GFCEXTERN (   type)    LIBIMP type LIBCALL

Defines a Geode C extern.

◆ LIBCALL

#define LIBCALL

Library Call.

◆ LIBEXP

#define LIBEXP

Library Export.

◆ LIBEXPORT

#define LIBEXPORT (   type)    type

Library Export a type.

◆ LIBIMP

#define LIBIMP   extern

Library Implementation.

Enumeration Type Documentation

◆ GfErrType

enum GfErrType

Error codes returned by Geode 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 Geode

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 Geode 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


Pivotal GemFire C++ Cache API Documentation