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.

  • About the C++ Client API

    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.

  • Creating a Cache

    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.

  • Adding an Entry to the Cache

    You can populate a client region with cache entries using the Region::put or the Region::create API functions. Code examples demonstrate these actions.

  • Accessing an Entry

    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.

  • Removing an Entry

    The standard Region::remove API removes the entry with the specified key and provides a user-defined parameter object to any CacheWriter or CacheListener invoked in the process.

  • Serializing Data

    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 and DataSerializable.

  • Using a Custom Class

    This example shows how to use the defined BankAccount custom key type and the AccountHistory value type.

  • Creating New Statistics

    This example provides a programmatic code sample for creating and registering new statistics.