C++ Client API Reference for Oracle Coherence
14c (14.1.2.0.0)

F79659-03

/scratch/cohbld/hudson/workspace/Coh_CPP-14.1.2.0-Linux-x64/prj/apidoc/mainpage.hpp

00001 /*
00002  * Copyright (c) 2000, 2020, Oracle and/or its affiliates.
00003  *
00004  * Licensed under the Universal Permissive License v 1.0 as shown at
00005  * http://oss.oracle.com/licenses/upl.
00006  */
00007 /**
00008 * @mainpage
00009 *
00010 * Coherence for C++ allows C++ applications to access Coherence clustered
00011 * services, including data, data events, and data processing from outside
00012 * the Coherence cluster. Typical uses of Coherence for C++ include desktop
00013 * and that require access to Coherence caches.
00014 *
00015 * The Coherence for C++ API consists of:
00016 * @li Shared libraries for a variety of compilers and operating systems
00017 * @li C++ API header files
00018 * @li API documentation
00019 *
00020 * The library allows applications to connect to Coherence*Extend proxies
00021 * running within the Coherence cluster using a high performance TCP/IP-based
00022 * communication layer. The library sends all client requests to the
00023 * Coherence*Extend clustered service which, in turn, responds to client
00024 * requests by delegating to an actual Coherence clustered service (for example
00025 * a Partitioned or Replicated cache service). As on other Coherence platforms,
00026 * C++ Coherence {@link coherence::net::NamedCache caches} are obtained from
00027 * the {@link coherence::net::CacheFactory CacheFactory}.
00028 *
00029 * In order for application data objects to be stored in the cluster they must
00030 * be serializable to the Coherence POF (Portable Object Format). This may be
00031 * accomplished by either modifying the data object to implement the
00032 * {@link coherence::io::pof::PortableObject PortableObject} interface, or
00033 * though the use of the helper template
00034 * {@link coherence::lang::Managed Managed<T>}. The latter offers an easy
00035 * integration route for existing C++ data objects as in most cases no changes
00036 * to the existing data object code are required.
00037 *
00038 * The Coherence for C++ API is pure C++ and is built on top of a managed object
00039 * model which handles the task of memory management. It is thus not necessary
00040 * or allowable to manually delete objects returned from or injected into the
00041 * cache. See {@link coherence::lang::Object Object} for an introduction to the
00042 * object model.
00043 */
Copyright © 2000, 2025, Oracle and/or its affiliates. Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.