C++ Client API
This section describes the primary classes and usage conventions for the C++ client API. It demonstrates how to use the API to create caches and perform data serialization.
The C++ API documentation is available at [C++ API]((http://geode.apache.org/docs/). It provides extensive implementation details for the C++ structures and functions.
Several example API programs are included in the SampleCode
directory. See QuickStart Examples.
-
The C++ client API allows C++ developers to programmatically create, populate, and manage a distributed system. The C++ library is thread-safe, except where specified otherwise in the API documentation.
-
The code snippets in this section show cache creation.
Creating a Proxy Client-Side Region
This section provides code examples for creating and customizing proxy client-side regions.
-
You can populate a client region with cache entries using the
Region::put
or theRegion::create
API functions. Code examples demonstrate these actions. -
The standard
Region::get API
method returns the value associated with the specified key, and passes the callback argument to any cache loaders or cache writers that are invoked in the operation. -
The standard
Region::remove
API removes the entry with the specified key and provides a user-defined parameter object to anyCacheWriter
orCacheListener
invoked in the process. -
All data moved out of the local cache must be serializable.
Implementing User-Defined Objects in Java Clients
You can use one of two methods to implement a user-defined object in a Java client that works with C++ clients:
Instantiator.register
andDataSerializable
.-
This example shows how to use the defined
BankAccount
custom key type and theAccountHistory
value type. -
This example provides a programmatic code sample for creating and registering new statistics.