Repository: geode-native Updated Branches: refs/heads/develop 00682c330 -> 374f929b5
GEODE-2513 Unbrand docs section Configuring the Native Client Cache - namespace updates - fix typos Project: http://git-wip-us.apache.org/repos/asf/geode-native/repo Commit: http://git-wip-us.apache.org/repos/asf/geode-native/commit/8f4925b7 Tree: http://git-wip-us.apache.org/repos/asf/geode-native/tree/8f4925b7 Diff: http://git-wip-us.apache.org/repos/asf/geode-native/diff/8f4925b7 Branch: refs/heads/develop Commit: 8f4925b775284ff48d0cc9ee20aa328c564aad60 Parents: 8b67c13 Author: Karen Miller <[email protected]> Authored: Tue Mar 28 15:25:23 2017 -0700 Committer: Karen Miller <[email protected]> Committed: Tue Mar 28 15:25:23 2017 -0700 ---------------------------------------------------------------------- .../source/subnavs/geode-nc-nav.erb | 4 ++-- .../about_native_client_users_guide.html.md.erb | 2 +- .../cache-init-file/chapter-overview.html.md.erb | 15 ++++++--------- .../client-cache/accessing-entries.html.md.erb | 10 +++++----- .../adding-entries-to-cache.html.md.erb | 7 ++----- .../client-cache/application-plugins.html.md.erb | 15 +++++++-------- .../client-cache/cache-management.html.md.erb | 4 ++-- .../client-cache/cache-ownership.html.md.erb | 4 ++-- .../client-cache/caches.html.md.erb | 10 +++++----- .../client-cache/caching-apis.html.md.erb | 4 ++-- .../client-cache/chapter-overview.html.md.erb | 6 +++--- .../client-to-server-connection.html.md.erb | 14 +++++++------- .../client-cache/closing-cache.html.md.erb | 2 +- .../consistency_checking_in_regions.html.md.erb | 6 +++--- .../client-cache/create-access-cache.html.md.erb | 9 ++++----- .../declarative-region-creation.html.md.erb | 2 +- .../getting-the-region-size.html.md.erb | 2 +- .../client-cache/invalidating-region.html.md.erb | 4 ++-- .../managing-lifetime-cached-object.html.md.erb | 4 ++-- .../notification-for-operations.html.md.erb | 4 ++-- .../overview-client-cache.html.md.erb | 7 +++---- .../client-cache/persistence-manager.html.md.erb | 18 +++++++++--------- .../client-cache/region-shortcuts.html.md.erb | 5 +++-- .../registering-interest-for-entries.html.md.erb | 8 ++++---- .../requirements-for-distrib.html.md.erb | 2 +- .../specify-region-attributes.html.md.erb | 2 +- .../client-cache/troubleshooting.html.md.erb | 4 ++-- .../client-cache/using-thread-safety.html.md.erb | 2 +- 28 files changed, 84 insertions(+), 92 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb b/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb index 063461f..3ef5826 100644 --- a/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb +++ b/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb @@ -111,13 +111,13 @@ limitations under the License. </ul> </li> <li class="has_submenu"> - <a href="/docs/guide-native/11/client-cache/chapter-overview.html">Configuring the Native Client Cache</a> + <a href="/docs/guide-native/11/client-cache/chapter-overview.html">Configuring the Client Cache</a> <ul> <li class="has_submenu"> <a href="/docs/guide-native/11/client-cache/caches.html">Caches</a> <ul> <li> - <a href="/docs/guide-native/11/client-cache/overview-client-cache.html">About the Native Client Cache</a> + <a href="/docs/guide-native/11/client-cache/overview-client-cache.html">About the Client Cache</a> </li> <li> <a href="/docs/guide-native/11/client-cache/caching-apis.html">Cache APIs</a> http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/about_native_client_users_guide.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/about_native_client_users_guide.html.md.erb b/docs/geode-native-docs/about_native_client_users_guide.html.md.erb index 538c284..cf89a7f 100644 --- a/docs/geode-native-docs/about_native_client_users_guide.html.md.erb +++ b/docs/geode-native-docs/about_native_client_users_guide.html.md.erb @@ -37,7 +37,7 @@ This documentation provides step-by-step procedures for installation, configurat - **[Configuring the Client Cache](client-cache/chapter-overview.html)** - *Configuring the Client Cache* describes the client cache functionality, initialization file, and APIs. It provides information about creating and working with caches, cache regions, and region entries. + This section describes the client cache functionality, initialization file, and APIs. It provides information about creating and working with caches, cache regions, and region entries. - **[C++ Client API](cpp-caching-api/cpp-caching-api.html)** http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/cache-init-file/chapter-overview.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/cache-init-file/chapter-overview.html.md.erb b/docs/geode-native-docs/cache-init-file/chapter-overview.html.md.erb index 7a086aa..056c28e 100644 --- a/docs/geode-native-docs/cache-init-file/chapter-overview.html.md.erb +++ b/docs/geode-native-docs/cache-init-file/chapter-overview.html.md.erb @@ -33,26 +33,23 @@ The initialization file can have any name, but is generally referred to as `cach The contents of a declarative XML file correspond to APIs declared in the `Cache.hpp` and `Region.hpp` header files. The cache initialization file allows you to accomplish declaratively many of the cache management activities that you can program through the API. -- The contents of the cache initialization file must conform to the XML definition in <code>_product-dir_/dtd/gfcpp-cache8000.dtd</code>. The DTD file identifies the valid element tags that may be present in your XML file, the attributes that correspond to each element, and the valid values for the elements and attributes. -- The name of the declarative XML file is specified when establishing a connection to the distributed system. You can define it by setting the `cache-xml-file` configuration attribute in the `geode.properties` file for the native client. For details about the `geode.properties` file, see [Setting System and Cache Properties](../setting-properties/chapter-overview.html). +- The contents of the cache initialization file must conform to the XML definition in [http://geode.apache.org/schema/cache/cache-1.0.xsd](http://geode.apache.org/schema/cache/cache-1.0.xsd). This file identifies the valid element tags that may be present in your XML file, the attributes that correspond to each element, and the valid values for the elements and attributes. +- The name of the declarative XML file is specified when establishing a connection to the distributed system. You can define it by setting the `cache-xml-file` configuration attribute in the `geode.properties` file for the client. For details about the `geode.properties` file, see [Setting System and Cache Properties](../setting-properties/chapter-overview.html). # Example cache.xml File An example `cache.xml` file shows cache and region initialization for a client, presenting a subset of the possible data configurations. -Specific information about cache and region attributes is in [Region Attributes](../client-cache/region-attributes.html). Also check the API documentation for `Cache` and `RegionAttributes` at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io). +Specific information about cache and region attributes is in [Region Attributes](../client-cache/region-attributes.html). -For information on using a cache with a server pool, see [Using Connection Pools](../connection-pools/connection-pools.html). The example below shows a `cache.xml` file that creates two regions. - -- Region `region1` is defined with a full set of region attributes and application plug-ins. The region's entries have `RegionTimeToLive` and `RegionIdleTimeout` expiration attributes set, as detailed in [Specifying Expiration Attributes](../client-cache/expiration-attributes.html). -- Region `region2` uses mostly default values. +For information on using a cache with a server pool, see [Using Connection Pools](../connection-pools/connection-pools.html). The example below shows a `cache.xml` file that creates a region. ``` pre <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE cache PUBLIC - "-//Example Systems, Inc.//Example Declarative Caching 8.0//EN" - "http://www.example.com/dtd/gfcpp-cache8000.dtd";> + "-//Example Systems, Inc.//Example Declarative Caching 1.0//EN" + "http://geode.apache.org/schema/cache/cache-1.0.xsd";> <!-- Sample cache.xml file --> <!-- Example Declarative Cache Initialization with cache.xml --> <cache> http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/accessing-entries.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/accessing-entries.html.md.erb b/docs/geode-native-docs/client-cache/accessing-entries.html.md.erb index 513264d..5f13246 100644 --- a/docs/geode-native-docs/client-cache/accessing-entries.html.md.erb +++ b/docs/geode-native-docs/client-cache/accessing-entries.html.md.erb @@ -20,21 +20,21 @@ limitations under the License. --> <a id="accessing-entries__section_310C0BE952BC489C9E97811DAE8736E4"></a> -Use the API to retrieve the entry key, entry value, and the `RegionEntry` object itself. A variety of functions provide information for individual entries and for the set of all entries resident in the region. The API documentation at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io) lists all available access functions. +Use the API to retrieve the entry key, entry value, and the `RegionEntry` object itself. A variety of functions provide information for individual entries and for the set of all entries resident in the region. A region's entry keys and `RegionEntry` objects are directly available from the local cache. Applications can directly access the local cache's stored entry value through the `RegionEntry::getValue` function. The `getValue` function either returns the value if a valid value is present in the local cache, or `NULL` if the value is not valid locally. This function does no data loading, nor does it look elsewhere in the distributed system for a valid value. **Note:** Direct access through `RegionEntry::getValue` does not reset an entry's timestamp for LRU expiration. See [Specifying Expiration Attributes](expiration-attributes.html) for more information about LRU expiration. -In comparison, the standard `Region::get` functions consider all caches and all applicable loaders in the distributed system in an attempt to return a valid entry value to the calling application. The primary attribute setting affecting entry retrieval is `CacheLoader`. See [Specifying Application Plug-In Attributes](application-plugins.html). +In comparison, the `Region::get` functions consider all caches and all applicable loaders in the distributed system in an attempt to return a valid entry value to the calling application. The primary attribute setting affecting entry retrieval is `CacheLoader`. See [Specifying Application Plug-In Attributes](application-plugins.html). -The standard `Region::get` functions may implement a number of operations in order to retrieve a valid entry value. The operations used depend on the region's attribute settings and on the state of the entry itself. By default, the client retrieves entry values through calls to the `get` function. The client can override this behavior for any region by defining a cache loader for the region. +The `Region::get` functions may implement more than one operation in order to retrieve a valid entry value. The operations used depend on the region's attribute settings and on the state of the entry itself. By default, the client retrieves entry values through calls to the `get` function. The client can override this behavior for any region by defining a cache loader for the region. The following sections discuss the `get` function and special considerations for entry retrieval. ## <a id="accessing-entries__section_AD6AFD842C144C128FA1C7F0B9283372" class="no-quick-link"></a>Entry Retrieval -You retrieve entry values with the `Region::get` function. +Retrieve entry values with the `Region::get` function. When an entry value is requested from a region, it is either retrieved from the cache server or fetched by the region's locally-defined cache loader in this sequence: @@ -52,4 +52,4 @@ Note that these load operations do not invoke a cache writer. Because the loader ## <a id="accessing-entries__section_F636614605C84513B2B7F4A674FD6E38" class="no-quick-link"></a>Getting Multiple Entries Using getAll -You can use the `getAll` Region API to get all values for an array of keys from the local cache or cache server. Subsection [Bulk Put Operations Using putAll](../cpp-caching-api/add-entry-to-cache.html#concept_26D4E6C6BC6F4AB8884E33119999656D__section_748916759F0246619CD27E7456DCA365) has more information. +You can use the `getAll` Region function to get all values for an array of keys from the local cache or cache server. Subsection [Bulk Put Operations Using putAll](../cpp-caching-api/add-entry-to-cache.html#concept_26D4E6C6BC6F4AB8884E33119999656D__section_748916759F0246619CD27E7456DCA365) has more information. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/adding-entries-to-cache.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/adding-entries-to-cache.html.md.erb b/docs/geode-native-docs/client-cache/adding-entries-to-cache.html.md.erb index 8ce55d6..283d999 100644 --- a/docs/geode-native-docs/client-cache/adding-entries-to-cache.html.md.erb +++ b/docs/geode-native-docs/client-cache/adding-entries-to-cache.html.md.erb @@ -30,12 +30,9 @@ A client can also use `getAll` to populate a region with all values for an array If any cache writer is available in the distributed region, it is called before the entry is created and it can abort the creation process. -**Note:** -For more information on how to create entries, see [Pivotal GemFire Native Client C++ API](../cpp-caching-api/cpp-caching-api.html), [Pivotal GemFire Native Client .NET API](../dotnet-caching-api/dotnet-caching-api.html), and the native client API reference at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io). - ## <a id="adding-entries-to-cache__section_873FFF2CAC804B8E9676AB8098CF2434" class="no-quick-link"></a>Adding Entries to the Local Cache -If just the local cache is to be populated, you can either `create` an entry using the `localCreate` Region API, or `put` an entry using `localPut`. See the C++ and .NET API documentation at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io) for details about `localCreate` and `localPut`. +If just the local cache is to be populated, you can either `create` an entry using the `localCreate` Region API, or `put` an entry using `localPut`. `DateTime` objects must be stored in the cache in UTC, so that times correspond between client and server. If you use a date with a different time zone, convert it when storing into and retrieving from the cache. This example converts a local time to UTC for a put operation: @@ -48,4 +45,4 @@ region0.Put( 1, t1.ToUniversalTime() ); If you need to add many cache entries to a region at one time, you can improve cache performance by using the `putAll` function to add them in a single distributed operation. Multiple key/value pairs are stored in a hashmap, then the hashmap contents are processed on the server as either new entries, updates, or invalidates for existing entries. -Under [Adding an Entry to the Cache](../cpp-caching-api/add-entry-to-cache.html) see the subsection titled Bulk Put Operations Using putAll for more information about the `putAll` API. Additional details are available in the API documentation for `Region::putAll` (C++), or `Region.PutAll` (.NET) at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io). +Under [Adding an Entry to the Cache](../cpp-caching-api/add-entry-to-cache.html) see the subsection titled Bulk Put Operations Using putAll for more information about the `putAll` API. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/application-plugins.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/application-plugins.html.md.erb b/docs/geode-native-docs/client-cache/application-plugins.html.md.erb index fa1d53f..c4c9370 100644 --- a/docs/geode-native-docs/client-cache/application-plugins.html.md.erb +++ b/docs/geode-native-docs/client-cache/application-plugins.html.md.erb @@ -71,9 +71,9 @@ Unlike cache loaders and cache writers, cache listeners only receive events for When the listener is attached to a region with caching disabled, the old value is always `NULL`. **Note:** -Do not perform region operations inside the cache listener. Once you have configured a cache listener, the event supplies the new entry values to the application. Performing a get with a key from the `EntryEvent` can result in distributed deadlock. For more about this, see the API documentation for `EntryEvent` at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io). +Do not perform region operations inside the cache listener. Once you have configured a cache listener, the event supplies the new entry values to the application. Performing a get with a key from the `EntryEvent` can result in distributed deadlock. For more about this, see the API documentation for `EntryEvent`. -When a region disconnects from a cache listener, you can implement the `afterRegionDisconnected` callback event. This callback event is only be invoked when using the `pool` API and `subscription` is enabled on the pool. For example: +When a region disconnects from a cache listener, you can implement the `afterRegionDisconnected` callback. This callback is only be invoked when using the `pool` API and `subscription` is enabled on the pool. For example: ``` pre class DisconnectCacheListener : public CacheListener @@ -101,13 +101,13 @@ Single hop is used for the following operations: `put`, `get`, `destroy`, `putAl Disable single hop behavior for a region by setting its pool attribute `pr-single-hop-enabled` to `false`. -See [<client-cache> Element Reference](geodeman/reference/topics/client-cache.html) for information on setting `pr-single-hop-enabled`. +See [<client-cache> Element Reference](geodeman/reference/topics/client-cache.html) in the server's documentation for information on setting `pr-single-hop-enabled`. -See [Partitioned Regions](geodeman/developing/partitioned_regions/chapter_overview.html) for more information, including colocating like data within a partitioned region and how to get the best performance with PR single hop. +See the server documentation on [Partitioned Regions](geodeman/developing/partitioned_regions/chapter_overview.html) for more information, including colocating like data within a partitioned region and how to get the best performance with PR single hop. **Implementing a PartitionResolver** -See [Custom-Partitioning and Colocating Data](geodeman/developing/partitioned_regions/overview_custom_partitioning_and_data_colocation.html) for information on custom-partitioning the server partitioned regions. +See the server documentation on [Custom-Partitioning and Colocating Data](geodeman/developing/partitioned_regions/overview_custom_partitioning_and_data_colocation.html) for information on custom-partitioning the server partitioned regions. 1. Implement `PartitionResolver` in the same place that you did in the server--custom class, key, or cache callback argument. 2. Program the resolver's functions the same way you programmed them in the Java implementation. Your implementation must match the server's. @@ -148,8 +148,7 @@ See [Custom-Partitioning and Colocating Data](geodeman/developing/partitioned_re ``` pre using System; using System.Threading; - // Use the GemFire namespace - using GemStone.GemFire.Cache; + using Apache.Geode.Client; class TradeKeyResolver : IPartitionResolver { private int m_month = 0; @@ -262,7 +261,7 @@ void removeListener(RegionPtr& region) ## <a id="application-plugins__section_428DCC57B6344603AA19DCAFCE483A10" class="no-quick-link"></a>Considerations for Implementing Callbacks -Keep your callback implementations lightweight and prevent situations that might cause them to hang. For example, do not perform distribution operations or disconnects inside events. +Keep your callback implementations lightweight and prevent situations that might cause them to hang. For example, do not perform distribution operations or disconnects inside event handlers. Your code should handle any exceptions that it generates. If not, Geode handles them as well as possible. Because C++ has no standard for exceptions, in many cases Geode can only print an `unknown error` message. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/cache-management.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/cache-management.html.md.erb b/docs/geode-native-docs/client-cache/cache-management.html.md.erb index c317066..90694c2 100644 --- a/docs/geode-native-docs/client-cache/cache-management.html.md.erb +++ b/docs/geode-native-docs/client-cache/cache-management.html.md.erb @@ -25,7 +25,7 @@ This section covers cache management. - **[Client-to-Server Connection Process](client-to-server-connection.html)** - It is important to understand the sequence of events that occur when the native client connects with a Geode cache server. + It is important to understand the sequence of events that occur when the client connects with a server. - **[Controlling Cache Size](controlling-cache-size.html)** @@ -41,6 +41,6 @@ This section covers cache management. - **[Troubleshooting](troubleshooting.html)** - This section provides troubleshooting information for the native client. + This section provides troubleshooting information for the client. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/cache-ownership.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/cache-ownership.html.md.erb b/docs/geode-native-docs/client-cache/cache-ownership.html.md.erb index 3c1a9cb..e8af29c 100644 --- a/docs/geode-native-docs/client-cache/cache-ownership.html.md.erb +++ b/docs/geode-native-docs/client-cache/cache-ownership.html.md.erb @@ -19,10 +19,10 @@ See the License for the specific language governing permissions and limitations under the License. --> -The *distributed system* defines how native client and cache server processes find each other. +The *distributed system* defines how client and server processes find each other. The distributed system keeps track of its membership list and makes its members aware of the identities of the other members in the distributed system. -A cache for a native client is referred to as its *local cache*. All other caches in the distributed system are considered *remote caches* to the application. Every cache server and application process has its own cache. The term *distributed cache* is used to describe the union of all caches in a Geode distributed system. +A cache within the client is referred to as its *local cache*. All other caches in the distributed system are considered *remote caches* to the application. Every cache server and application process has its own cache. The term *distributed cache* is used to describe the union of all caches in the distributed system. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/caches.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/caches.html.md.erb b/docs/geode-native-docs/client-cache/caches.html.md.erb index 6b00a34..3e540fa 100644 --- a/docs/geode-native-docs/client-cache/caches.html.md.erb +++ b/docs/geode-native-docs/client-cache/caches.html.md.erb @@ -19,23 +19,23 @@ See the License for the specific language governing permissions and limitations under the License. --> -The cache is the entry point to native client data caching in Geode. Through the cache, native clients gain access to the Geode caching framework for data loading, distribution, and maintenance. +The cache is the entry point to data caching in Geode. Through the cache, clients gain access to the Geode caching framework for data loading, distribution, and maintenance. -- **[About the Native Client Cache](overview-client-cache.html)** +- **[About the Client Cache](overview-client-cache.html)** The cache consists of data regions, each of which can contain any number of entries. Region entries hold the cached data. Every entry has a key that uniquely identifies it within the region and a value where the data object is stored. - **[Cache APIs](caching-apis.html)** - The native client has two cache APIs, `RegionService` and `Cache`. + The client has two cache APIs, `RegionService` and `Cache`. - **[Local, Remote, and Distributed Caches](cache-ownership.html)** - The *distributed system* defines how native client and cache server processes find each other. + The *distributed system* defines how client and cache server processes find each other. - **[Creating and Accessing a Cache](create-access-cache.html)** - When you create a native client cache, you are creating a native client cache instance. You must provide some basic configuration information such as a connection name and cache initialization parameters for the native client's cache instance. + When you create a client cache, you are creating a client cache instance. You must provide some basic configuration information such as a connection name and cache initialization parameters for the client's cache instance. - **[Closing the Cache](closing-cache.html)** http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/caching-apis.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/caching-apis.html.md.erb b/docs/geode-native-docs/client-cache/caching-apis.html.md.erb index 573f642..1a33d67 100644 --- a/docs/geode-native-docs/client-cache/caching-apis.html.md.erb +++ b/docs/geode-native-docs/client-cache/caching-apis.html.md.erb @@ -19,14 +19,14 @@ See the License for the specific language governing permissions and limitations under the License. --> -The native client has two cache APIs, `RegionService` and `Cache`. +The client has two cache APIs, `RegionService` and `Cache`. ## <a id="caching-apis__section_8F81996678B64BBE94EF352527F7F006" class="no-quick-link"></a>RegionService API `RegionService` provides: - Access to existing cache regions. -- Access to the standard query service for the cache, which sends queries to the servers. See [Remote Querying](../remote-querying/remote-querying.html) and [Continuous Querying](../continuous-querying/continuous-querying.html). +- Access to the query service for the cache, which sends queries to the servers. See [Remote Querying](../remote-querying/remote-querying.html) and [Continuous Querying](../continuous-querying/continuous-querying.html). `RegionService` is inherited by `Cache`. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/chapter-overview.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/chapter-overview.html.md.erb b/docs/geode-native-docs/client-cache/chapter-overview.html.md.erb index 6e8f750..e68b316 100644 --- a/docs/geode-native-docs/client-cache/chapter-overview.html.md.erb +++ b/docs/geode-native-docs/client-cache/chapter-overview.html.md.erb @@ -19,13 +19,13 @@ See the License for the specific language governing permissions and limitations under the License. --> -*Configuring the Native Client Cache* describes the native client cache functionality, initialization file, and APIs. It provides information about creating and working with caches, cache regions, and region entries. +This section describes the client cache functionality, initialization file, and APIs. It provides information about creating and working with caches, cache regions, and region entries. -The native client cache provides a framework for native clients to store, manage, and distribute application data. +The client cache provides a framework for clients to store, manage, and distribute application data. - **[Caches](caches.html)** - The cache is the entry point to native client data caching in Geode. Through the cache, native clients gain access to the Geode caching framework for data loading, distribution, and maintenance. + The cache is the entry point to data caching in Geode. Through the cache, clients gain access to the Geode caching framework for data loading, distribution, and maintenance. - **[Cache Initialization File (cache.xml)](../cache-init-file/chapter-overview.html)** http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/client-to-server-connection.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/client-to-server-connection.html.md.erb b/docs/geode-native-docs/client-cache/client-to-server-connection.html.md.erb index 1aeb359..b0d2475 100644 --- a/docs/geode-native-docs/client-cache/client-to-server-connection.html.md.erb +++ b/docs/geode-native-docs/client-cache/client-to-server-connection.html.md.erb @@ -19,26 +19,26 @@ See the License for the specific language governing permissions and limitations under the License. --> -It is important to understand the sequence of events that occur when the native client connects with a Geode cache server. +It is important to understand the sequence of events that occur when the client connects with a server. <a id="client-to-server-connection__section_C1E805D842FD44B984041C2ED1D4C2EF"></a> -1. A native client region is configured in `cache.xml` or programmatically with a set of server connection endpoints. Server endpoints identify each cache server by specifying the server's name and port number. +1. A client region is configured in `cache.xml` or programmatically with a set of server connection endpoints. Server endpoints identify each cache server by specifying the server's name and port number. - Client threads obtain, use, and release a connection to a connection pool that maintains new connections. The number of connections that a client can establish is governed by the pool's `min-connections` and `max-connections` settings, either using client XML configuration or programmatically through the `CacheFactory::setMinConnections()` and `CacheFactory::setMaxConnections()` APIs. The defaults for `min-connections` is 1 and `max-connections` is -1 meaning the connection count can grow to accommodate the number of active threads performing region operations. + Client threads obtain, use, and release a connection to a connection pool that maintains new connections. The number of connections that a client can establish is governed by the pool's `min-connections` and `max-connections` settings, either using client XML configuration or programmatically through the `CacheFactory::setMinConnections()` and `CacheFactory::setMaxConnections()` functions. The defaults for `min-connections` is 1 and `max-connections` is -1 meaning the connection count can grow to accommodate the number of active threads performing region operations. - This example shows how to use `cache.xml` to configure a native client region with endpoints set to two cache servers: + This example shows how to use `cache.xml` to configure a client region with endpoints set to two cache servers: ``` pre <pool name="examplePool" subscription-enabled="true" > <server host="java_servername1" port="java_port1" /> <server host="java_servername2" port="java_port2" /> </pool> - <region name="NativeClientRegion" refid="CACHING_PROXY"> + <region name="ClientRegion" refid="CACHING_PROXY"> <region-attributes pool-name="examplePool"/> </region> ``` - TCP connections on the native client are specified at the cache level, or by overriding endpoints for specific regions. The connections are created as the regions are created. In addition, connections can also get created for querying without having any created regions. In this case, when endpoints are defined at the cache level no regions are yet created and a query is fired. + TCP connections on the client are specified at the cache level, or by overriding endpoints for specific regions. The connections are created as the regions are created. In addition, connections can also get created for querying without having any created regions. In this case, when endpoints are defined at the cache level no regions are yet created and a query is fired. You can configure client-server connections in two ways. Use either the region/cache endpoints or the Pool API. For more information about the pool API, see [Using Connection Pools](../connection-pools/connection-pools.html). @@ -48,7 +48,7 @@ It is important to understand the sequence of events that occur when the native - Caching enabled in the client region, by using the `CACHING_PROXY RegionShortcut` setting in the region attribute `refid`. A listener could also be defined so event notification occurs. You can use both, but at least one of the two methods must be used by the client to receive event notifications. - Set `subscription-enabled` to `true` so the client receives update notifications from the server for entries to which it has registered interest. -4. A native client application calls the C++ or .NET API to connect to a cache server. +4. A client application calls the C++ or .NET API to connect to a cache server. 5. The client and the cache server exchange a handshake over a configured endpoint to create a connection. 6. Any `create`, `put`, `invalidate`, and `destroy` events sent to the server are propagated across the distributed cache so the client can receive the events. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/closing-cache.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/closing-cache.html.md.erb b/docs/geode-native-docs/client-cache/closing-cache.html.md.erb index a0366fd..c795d95 100644 --- a/docs/geode-native-docs/client-cache/closing-cache.html.md.erb +++ b/docs/geode-native-docs/client-cache/closing-cache.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. Use the `Cache::close` function to release system resources when you finish using the cache. -After the cache is closed, any further method calls on the cache or any region object result in a `CacheClosedException` . +After the cache is closed, any further method calls on the cache or any region object result in a `CacheClosedException`. If the cache is in a durable client, you need to use the `keepalive` version of the close method. See [Disconnecting From the Server](../preserving-data/disconnecting-from-server.html). http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/consistency_checking_in_regions.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/consistency_checking_in_regions.html.md.erb b/docs/geode-native-docs/client-cache/consistency_checking_in_regions.html.md.erb index 1a0d99b..f510c34 100644 --- a/docs/geode-native-docs/client-cache/consistency_checking_in_regions.html.md.erb +++ b/docs/geode-native-docs/client-cache/consistency_checking_in_regions.html.md.erb @@ -25,10 +25,10 @@ By default Geode members perform consistency checks when they apply updates to a Although a region must have the same consistency checking configuration on all Geode members that host the region, you can optionally disable consistency checking in a client cache region while leaving consistency checking enabled for the region on Geode members. This configuration may be necessary in certain cases where the client must view all updates to a given region, even when Geode members discards an update in order to preserve region consistency. -See [Consistency for Region Updates](geodeman/developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045) for more information. +See [Consistency for Region Updates](geodeman/developing/distributed_regions/region_entry_versions.html#topic_CF2798D3E12647F182C2CEC4A46E2045) in the server's documentation for more information. -## <a id="concept_77340A4999AC4861972A0EE10303E557__section_167CD194A5374C64B4064783490F3EA8" class="no-quick-link"></a>Native Client Overhead for Consistency Checks +## <a id="concept_77340A4999AC4861972A0EE10303E557__section_167CD194A5374C64B4064783490F3EA8" class="no-quick-link"></a>Client Overhead for Consistency Checks -In the native client regions, the overhead for performing consistency check is an additional 11 bytes per region entry. This overhead is slightly smaller than the overhead required to provide consistency checking on server-side region entries. +In the client regions, the overhead for performing consistency check is an additional 11 bytes per region entry. This overhead is slightly smaller than the overhead required to provide consistency checking on server-side region entries. If you cannot support the additional overhead in your deployment, you can disable consistency checks by setting the region attribute `concurrency-checks-enabled` to false for each region hosted by your client. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/create-access-cache.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/create-access-cache.html.md.erb b/docs/geode-native-docs/client-cache/create-access-cache.html.md.erb index 9e5b315..fbdeb65 100644 --- a/docs/geode-native-docs/client-cache/create-access-cache.html.md.erb +++ b/docs/geode-native-docs/client-cache/create-access-cache.html.md.erb @@ -19,12 +19,12 @@ See the License for the specific language governing permissions and limitations under the License. --> -When you create a native client cache, you are creating a native client cache instance. You must provide some basic configuration information such as a connection name and cache initialization parameters for the native client's cache instance. +When you create a client cache, you are creating a client cache instance. You must provide some basic configuration information such as a connection name and cache initialization parameters for the client's cache instance. When you create a cache, you provide the following input: - **Connection name**. Used in logging to identify both the distributed system connection and the cache instance. If you do not specify a connection name, a unique (but non-descriptive) default name is assigned. -- **`cache.xml` to initialize the cache (if the initialization is not done programmatically)**. To modify the cache structure, edit `cache.xml` in your preferred text editor. No changes to the application code are required. If you do not specify a cache initialization file, you need to initialize the cache programmatically. +- **`cache.xml` to initialize the cache (if the initialization is not done programmatically)**. To modify the cache structure, edit `cache.xml` in your preferred text editor. No changes to the application code are required. If you do not specify a `cache.xml` file, you need to initialize the cache programmatically. The `cache.xml` file contains XML declarations for cache, region, and region entry configuration. @@ -56,8 +56,7 @@ This file can have any name, but is generally referred to as `cache.xml` . For a list of the parameters in the `cache.xml` file, including the DTD, see [Cache Initialization File](../cache-init-file/chapter-overview.html). To create your cache, call the `CacheFactory create` function. - -The `cache` object it returns gives access to the native client caching API. For example: +The `cache` object it returns gives access to the client caching API. For example: ``` pre CacheFactoryPtr cacheFactory = CacheFactory::createCacheFactory(); @@ -65,6 +64,6 @@ CachePtr cachePtr = cacheFactory->create(); ``` -**Note:** For more information on how to create a cache, see the [Pivotal GemFire Native Client C++ API section on creating a cache](../cpp-caching-api/creating-cache.html) or the [Pivotal GemFire Native Client .NET API section on creating a cache](../dotnet-caching-api/creating-a-cache.html). +**Note:** For more information on how to create a cache for C++ clients, see [Creating a Cache](../cpp-caching-api/creating-cache.html), or for .NET clients, see [Creating a Cache](../dotnet-caching-api/creating-a-cache.html). http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/declarative-region-creation.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/declarative-region-creation.html.md.erb b/docs/geode-native-docs/client-cache/declarative-region-creation.html.md.erb index eafd904..ab07b5d 100644 --- a/docs/geode-native-docs/client-cache/declarative-region-creation.html.md.erb +++ b/docs/geode-native-docs/client-cache/declarative-region-creation.html.md.erb @@ -48,5 +48,5 @@ Regions are placed inside the cache declaration in `region` elements. For exampl ``` -The `cache.xml` file contents must conform to the DTD provided in the <code>_product-dir_/dtd/gfcpp-cache8000.dtd</code> file. For details, see [Cache Initialization File](../cache-init-file/chapter-overview.html). +The `cache.xml` file contents must conform to the XML described at [http://geode.apache.org/schema/cache/cache-1.0.xsd](http://geode.apache.org/schema/cache/cache-1.0.xsd). For details, see [Cache Initialization File](../cache-init-file/chapter-overview.html). http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/getting-the-region-size.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/getting-the-region-size.html.md.erb b/docs/geode-native-docs/client-cache/getting-the-region-size.html.md.erb index 824f91c..2f96133 100644 --- a/docs/geode-native-docs/client-cache/getting-the-region-size.html.md.erb +++ b/docs/geode-native-docs/client-cache/getting-the-region-size.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. The `Region` API provides a `size` method (`Size` property for .NET) that gets the size of a region. -For native client regions, this gives the number of entries in the local cache, not on the servers. +For client regions, this gives the number of entries in the local cache, not on the servers. See the `Region` API documentation for details. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/invalidating-region.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/invalidating-region.html.md.erb b/docs/geode-native-docs/client-cache/invalidating-region.html.md.erb index 3330422..b45dcb1 100644 --- a/docs/geode-native-docs/client-cache/invalidating-region.html.md.erb +++ b/docs/geode-native-docs/client-cache/invalidating-region.html.md.erb @@ -24,14 +24,14 @@ Invalidation marks all entries contained in the region as invalid (with null val <a id="invalidating-region__section_6F7E304D1D5743F1B53FCBD4F82651D0"></a> You can execute these operations explicitly in the local cache in the following ways: -- Through direct API calls from the native client. +- Through direct API calls from the client. - Through expiration activities based on the region's statistics and attribute settings. In either case, you can perform invalidation and destruction as a local or a distributed operation. - A local operation affects the region only in the local cache. - A distributed operation works first on the region in the local cache and then distributes the operation to all other caches where the region is defined. This is the proper choice when the region is no longer needed, or valid, for any application in the distributed system. -- If the region on the server is configured as a partitioned region, it cannot be cleared using API calls from the native client. +- If the region on the server is configured as a partitioned region, it cannot be cleared using API calls from the client. A user-defined cache writer can abort a region destroy operation. Cache writers are synchronous listeners with the ability to abort operations. If a cache writer is defined for the region anywhere in the distributed system, it is invoked before the region is explicitly destroyed. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/managing-lifetime-cached-object.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/managing-lifetime-cached-object.html.md.erb b/docs/geode-native-docs/client-cache/managing-lifetime-cached-object.html.md.erb index 69cb2b5..38832af 100644 --- a/docs/geode-native-docs/client-cache/managing-lifetime-cached-object.html.md.erb +++ b/docs/geode-native-docs/client-cache/managing-lifetime-cached-object.html.md.erb @@ -24,7 +24,7 @@ All cacheable objects derive from `SharedBase` , which provides reference counti <a id="managing-lifetime-cached-object__section_5F8E6FE4F9AB4C658516DB0D31DD4FF8"></a> When `SharedPtr` retrieves a cached object, the object remains alive as long as that pointer or the cache itself references the object. -A native client may have many pointers that reference an object. Regardless of how many pointers to the object are deleted, the object remains alive until the last remaining pointer is deleted. At that point the object is deleted. +A client may have many pointers that reference an object. Regardless of how many pointers to the object are deleted, the object remains alive until the last remaining pointer is deleted. At that point the object is deleted. This is a very simple example: @@ -36,7 +36,7 @@ region.put("key", p) ; In the example: - The act of object creation allocates memory and initializes the object. -- When you assign the object to a `SharedPtr` , you relinquish control of the lifetime of that object to the reference counting mechanism for the cache. +- When you assign the object to a `SharedPtr`, you relinquish control of the lifetime of that object to the reference counting mechanism for the cache. - The put operation does not actually copy the object into the cache. Rather, it copies a `SharedPtr` into the cache's hashmap. Consequently, the object remains alive in the cache when the original `SharedPtr` goes away. The client can make use of an object after you have initialized the object. For example, another `SharedPtr` might issue a `get` to retrieve the object from the cache: http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/notification-for-operations.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/notification-for-operations.html.md.erb b/docs/geode-native-docs/client-cache/notification-for-operations.html.md.erb index b72e57c..76185b9 100644 --- a/docs/geode-native-docs/client-cache/notification-for-operations.html.md.erb +++ b/docs/geode-native-docs/client-cache/notification-for-operations.html.md.erb @@ -22,12 +22,12 @@ limitations under the License. <a id="notification-for-operations__section_53F43C51118C4087915CB954CA3439E0"></a> Listeners are invoked for client-initiated operations only after the client operation succeeds on the server. Listener invocation on the client indicates that the server has the same data as the client. -If a client operation fails on the server, the operation is rolled back, assuming that no other thread has modified the data in the intervening period. Rollback may not be possible in cases where the entry has been evicted by LRU or expiration during this period. Thus when an exception is received from the server for an operation, local changes may not have been rolled back +If a client operation fails on the server, the operation is rolled back, assuming that no other thread has modified the data in the intervening period. Rollback may not be possible in cases where the entry has been evicted by LRU or expiration during this period. Thus when an exception is received from the server for an operation, local changes may not have been rolled back. ## <a id="notification-for-operations__section_48240559E20D4FAF8FDEC8D62C098357" class="no-quick-link"></a>Event Notification Sequence Events received on the clients that originated on the server invoke the subscription for the event as seen by the server. Events originating on the client invoke the subscription as seen by the client. -For example, a client that receives a `create` and an `update` from the server fires a `create` event and an `update` event because that is how the server saw it. A cacheless client that does two consecutive put operations has two `afterCreate` events invoked on the originating client because the client does not have any history about the first put , since it is cacheless. +For example, a client that receives a `create` and an `update` from the server fires a `create` event and an `update` event because that is how the server saw it. A cacheless client that does two consecutive put operations has two `afterCreate` events invoked on the originating client because the client does not have any history about the first put, since it is cacheless. For the same sequence, the server sees an `afterCreate` and an `afterUpdate` event, and a remote client receiving the event sees an `afterCreate` followed by an `afterUpdate` event. A client that caches locally sees an `afterCreate` and an `afterUpdate` for the same scenario (as will the server and remote clients). http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/overview-client-cache.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/overview-client-cache.html.md.erb b/docs/geode-native-docs/client-cache/overview-client-cache.html.md.erb index 3d8d582..dbd6d9e 100644 --- a/docs/geode-native-docs/client-cache/overview-client-cache.html.md.erb +++ b/docs/geode-native-docs/client-cache/overview-client-cache.html.md.erb @@ -1,5 +1,5 @@ --- -title: About the Native Client Cache +title: About the Client Cache --- <!-- @@ -27,7 +27,7 @@ Regions are created from the `Cache` instance. Regions provide the entry point t ## <a id="native-client-cache__section_A0F2E9EF30324736BD0D5F92FE3D1BD7" class="no-quick-link"></a>Main Features and Functionality -The native client cache provides the following features and functionality. +The client cache provides the following features and functionality. - Local and distributed data caching for fast access. - Data distribution between applications on the same or different platforms. @@ -36,7 +36,6 @@ The native client cache provides the following features and functionality. - Automated and application-specific data eviction for freeing up space in the cache, including optional overflow to disk. - System message logging, and statistics gathering and archiving. -For more information specific to your client programming language, see [Pivotal GemFire Native Client C++ API](../cpp-caching-api/cpp-caching-api.html#concept_CEC658A999414AC3A494578C214BF64E) and [Pivotal GemFire Native Client .NET Caching API](../dotnet-caching-api/dotnet-caching-api.html#concept_FC6776DCE6ED48B887A6137761104AA4). -The API references are at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io). +For more information specific to your client programming language, see [C++ Client API](../cpp-caching-api/cpp-caching-api.html) or [.NET Client API](../dotnet-caching-api/dotnet-caching-api.html). http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/persistence-manager.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/persistence-manager.html.md.erb b/docs/geode-native-docs/client-cache/persistence-manager.html.md.erb index 8f804df..2e3a733 100644 --- a/docs/geode-native-docs/client-cache/persistence-manager.html.md.erb +++ b/docs/geode-native-docs/client-cache/persistence-manager.html.md.erb @@ -40,11 +40,11 @@ The optional properties set parameters for the plug-in. ## <a id="persistence-manager__section_9FC7089FDF8044868F17A2659397402A" class="no-quick-link"></a>Using SQLite as a Persistence Manager -The Geode native client distribution includes a persistence manager that uses the open-source SQLite library. +The client distribution includes a persistence manager that uses the open-source SQLite library. SQLite is a software library that implements a self-contained transactional SQL database. SQLite does not require its own server or separate configuration, and the source code for SQLite is in the public domain. For more information on SQLite, see [http://www.sqlite.org](http://www.sqlite.org). -Each SQLite persistence manager persists its region data in a SQLite database that is stored in disk files. In a given native client application process, each region must have a unique persistence (overflow) directory. +Each SQLite persistence manager persists its region data in a SQLite database that is stored in disk files. In a given client application process, each region must have a unique persistence (overflow) directory. <a id="persistence-manager__fig_6A0C9F1A29134ACBA0FDD8236CD836B6"></a> <span class="figtitleprefix">Figure: </span>SQLite Database Persistence Manager Directory Structure @@ -63,7 +63,7 @@ The following table describes the region attributes that can be configured for t ## <a id="persistence-manager__section_A9583FBEB5D74B92AD61CB6158AE2B4C" class="no-quick-link"></a>Configuring the SQLite Persistence Manager Plug-In for C++ Applications -To load the SQLite persistence manager plug-in for C++ applications, you can configure it either in your client's `cache.xml` or programmatically using the native client C++ API. +To load the SQLite persistence manager plug-in for C++ applications, you can configure it either in your client's `cache.xml` or programmatically using the C++ client API. The following is an example of how to specify the following region attributes in your client's cache.xml: @@ -81,7 +81,7 @@ The following is an example of how to specify the following region attributes in ## C++ API Example -To use the native client C++ API, set SQLite persistence manager attributes programmatically as follows: +To use the C++ client API, set SQLite persistence manager attributes programmatically as follows: ``` pre PropertiesPtr sqliteProperties = Properties::create(); @@ -97,8 +97,8 @@ regionFactory->setPersistenceManager("SqLiteImpl","createSqLiteInstance", To load the SQLite persistence manager plug-in for .NET applications, you can configure it either in your client's cache.xml or programmatically using the .NET API: ``` pre -<persistence-manager library-name="Gemstone.Gemfire.Plugins.SqLite" - library-function-name="GemStone.GemFire.Plugins.SqLite.SqLiteImpl<System.Object, System.Object>.Create"> +<persistence-manager library-name="Apache.Geode.Plugins.SqLite" + library-function-name="Apache.Geode.Plugins.SqLite.SqLiteImpl<System.Object, System.Object>.Create"> <properties> <property name="PersistenceDirectory" value="SqLite"/> <property name="MaxPageCount" value="1073741823"/> @@ -109,15 +109,15 @@ To load the SQLite persistence manager plug-in for .NET applications, you can co ## .NET API Example -To use the native client .NET API, set the SQLite persistence manager attributes programmatically as follows: +To use the .NET client API, set the SQLite persistence manager attributes programmatically as follows: ``` pre Properties<string, string> sqliteProperties = new Properties<string, string>(); sqliteProperties.Insert("PageSize", "65536"); sqliteProperties.Insert("MaxFileSize", "51200000"); sqliteProperties.Insert("PersistenceDirectory", SqLiteDir); -rf.SetPersistenceManager("Gemstone.Gemfire.Plugins.SqLite", -"Gemstone.Gemfire.Plugins.SqLiteSqLiteImpl<System.Object,System.Object>.Create", +rf.SetPersistenceManager("Apache.Geode.Plugins.SqLite", +"Apache.Geode.Plugins.SqLite.SqLiteImpl<System.Object,System.Object>.Create", sqliteProperties); ``` http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/region-shortcuts.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/region-shortcuts.html.md.erb b/docs/geode-native-docs/client-cache/region-shortcuts.html.md.erb index 0a3d916..7ce17cf 100644 --- a/docs/geode-native-docs/client-cache/region-shortcuts.html.md.erb +++ b/docs/geode-native-docs/client-cache/region-shortcuts.html.md.erb @@ -20,7 +20,7 @@ limitations under the License. --> <a id="region-shortcuts__section_62D2AB580EDB4165970E4FC42A35C80B"></a> -Geode provides a number of predefined, shortcut region attributes settings for your use, in `RegionShortcut`. +Geode provides predefined, shortcut region attributes settings for your use, in `RegionShortcut`. Shortcut attributes are a convenience only. They are named attributes that Geode has already stored for you. You can override their settings by storing new attributes with the same `id` as the predefined attributes. @@ -69,7 +69,8 @@ This section provides an overview of the options available in the region shortcu **Data Eviction** -For the non-`PROXY` regions--the regions that store data in the client cache--you can add data eviction: +Non-`PROXY` regions are those that store data in the client cache. +You can add data eviction for non-`PROXY` regions: - `ENTRY_LRU` causes least recently used data to be evicted from memory when the region reaches the entry count limit. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/registering-interest-for-entries.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/registering-interest-for-entries.html.md.erb b/docs/geode-native-docs/client-cache/registering-interest-for-entries.html.md.erb index 9ee7c87..dfc570b 100644 --- a/docs/geode-native-docs/client-cache/registering-interest-for-entries.html.md.erb +++ b/docs/geode-native-docs/client-cache/registering-interest-for-entries.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -For native client regions, you can programmatically register interest in entry keys stored on a cache server region. A client region receives update notifications from the cache server for the keys of interest. +For client regions, you can programmatically register interest in entry keys stored on a cache server region. A client region receives update notifications from the cache server for the keys of interest. You can register interest for specific entry keys or for all keys. Regular expressions can be used to register interest for keys whose strings match the expression. You can also unregister interest for specific keys, groups of keys based on regular expressions, or for all keys. @@ -37,11 +37,11 @@ The `registerKeys`, `registerRegex` and `registerAllKeys` methods have the optio In addition to the programmatic function calls, to register interest for a server region and receive updated entries you need to configure the region with the `PROXY` or `CACHING_PROXY RegionShortcut` setting. The region's pool should have `subscription-enabled=true` set either in the client XML or programmatically via a `CacheFactory::setSubscriptionEnabled(true)` API call. Otherwise, when you register interest, you will get an `UnsupportedOperationException`. ``` pre -<region name = "listenerWriterLoader" refid="CACHING_PROXY"> +<region name="listenerWriterLoader" refid="CACHING_PROXY"> ... ``` -Both native clients and Java clients that have subscriptions enabled track and drop (ignore) any duplicate notifications received. To reduce resource usage, a client expires tracked sources for which new notifications have not been received for a configurable amount of time. +All clients that have subscriptions enabled track and drop (ignore) any duplicate notifications received. To reduce resource usage, a client expires tracked sources for which new notifications have not been received for a configurable amount of time. **Notification Sequence** @@ -107,4 +107,4 @@ In this register interest scenario, a cache listener is used with a cacheless re When a value changes in another client, it sends the event to the server. The server will not send the event to the cacheless client, even though `client-notification` is set to `true`. -To activate the cache listener so the cacheless region receives updates, the client should explicitly register interest in some or all keys by using one of the API calls for registering interest. This way, the client receives all events for the keys to which it has registered interest. This applies to Java-based clients as well as native clients. +To activate the cache listener so the cacheless region receives updates, the client should explicitly register interest in some or all keys by using one of the API calls for registering interest. This way, the client receives all events for the keys to which it has registered interest. This applies to Java-based clients as well as non-Java clients. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/requirements-for-distrib.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/requirements-for-distrib.html.md.erb b/docs/geode-native-docs/client-cache/requirements-for-distrib.html.md.erb index 93f65d3..7f990c8 100644 --- a/docs/geode-native-docs/client-cache/requirements-for-distrib.html.md.erb +++ b/docs/geode-native-docs/client-cache/requirements-for-distrib.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. Entry data distributed among members of the distributed system must be serializable. Entry keys and values are serialized for distribution. -If a native client defines a region, it must register any serializable types for all classes of objects stored in the region. This includes entries that the application gets or puts, as well as entries that are pushed to the client's cache automatically through distribution. The types must be registered before the native client connects to the distributed system. +If a client defines a region, it must register any serializable types for all classes of objects stored in the region. This includes entries that the application gets or puts, as well as entries that are pushed to the client's cache automatically through distribution. The types must be registered before the client connects to the distributed system. See [Serializing Data](../cpp-caching-api/serialization_overview.html#concept_2A8DC49D93394392BA34B17AA3452B14) for more information about these requirements. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/specify-region-attributes.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/specify-region-attributes.html.md.erb b/docs/geode-native-docs/client-cache/specify-region-attributes.html.md.erb index 013bcf6..45b77f7 100644 --- a/docs/geode-native-docs/client-cache/specify-region-attributes.html.md.erb +++ b/docs/geode-native-docs/client-cache/specify-region-attributes.html.md.erb @@ -21,6 +21,6 @@ limitations under the License. Region attributes govern the automated management of a region and its entries. -Specify region attributes before creating the region. You can do this either through the declarative XML file or through the API. The API includes classes for defining a region's attributes before creation and for modifying some of them after creation. For details, see the API for `RegionShortcut`, `RegionAttributes`, `AttributesFactory`, and `AttributesMutator` at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io). +Specify region attributes before creating the region. You can do this either through the declarative XML file or through the API. The API includes classes for defining a region's attributes before creation and for modifying some of them after creation. For details, see the API for `RegionShortcut`, `RegionAttributes`, `AttributesFactory`, and `AttributesMutator`. http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/troubleshooting.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/troubleshooting.html.md.erb b/docs/geode-native-docs/client-cache/troubleshooting.html.md.erb index 91c6d57..05710f6 100644 --- a/docs/geode-native-docs/client-cache/troubleshooting.html.md.erb +++ b/docs/geode-native-docs/client-cache/troubleshooting.html.md.erb @@ -19,11 +19,11 @@ See the License for the specific language governing permissions and limitations under the License. --> -This section provides troubleshooting information for the native client. +This section provides troubleshooting information for the client. ## <a id="troubleshooting__section_32E817A073B8408F8FEDB5599C5CCEF6" class="no-quick-link"></a>Cannot Acquire Windows Performance Data -When you attempt to run performance measurements for the native client on Windows, you may encounter the following error message in the run logs: +When you attempt to run performance measurements for the client on Windows, you may encounter the following error message in the run logs: ``` pre Can't get Windows performance data. RegQueryValueEx returned 5 http://git-wip-us.apache.org/repos/asf/geode-native/blob/8f4925b7/docs/geode-native-docs/client-cache/using-thread-safety.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/client-cache/using-thread-safety.html.md.erb b/docs/geode-native-docs/client-cache/using-thread-safety.html.md.erb index eb8330d..33e7409 100644 --- a/docs/geode-native-docs/client-cache/using-thread-safety.html.md.erb +++ b/docs/geode-native-docs/client-cache/using-thread-safety.html.md.erb @@ -23,7 +23,7 @@ When you perform structural changes on your cache, such as creating or closing a Other non-structural operations, like region gets, puts, and queries, are thread safe, and you can perform them in a multithreaded way. There are caveats to this, for example, when two threads update the same key simultaneously, there is no way to determine which thread's operation will prevail. -You may need to protect cached objects from concurrent usage and modification. The native client does not guard cached objects themselves from concurrent access. +You may need to protect cached objects from concurrent usage and modification. The client does not guard cached objects themselves from concurrent access. Always catch and handle exceptions that may be thrown, for problems like trying to create a `Pool` with the same name more than once.
