You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2018/04/27 18:17:35 UTC
[geode-native] branch develop updated: GEODE-4728: Docs - Region
attributes - delete XML examples
This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode-native.git
The following commit(s) were added to refs/heads/develop by this push:
new 68887a0 GEODE-4728: Docs - Region attributes - delete XML examples
68887a0 is described below
commit 68887a0f73395474cb1a0fb2f3dd924222b78741
Author: Dave Barnes <db...@pivotal.io>
AuthorDate: Fri Apr 27 11:17:29 2018 -0700
GEODE-4728: Docs - Region attributes - delete XML examples
---
.../regions/region-attributes.html.md.erb | 128 +++++++--------------
docs/geode-native-docs/regions/regions.html.md.erb | 21 ++--
2 files changed, 54 insertions(+), 95 deletions(-)
diff --git a/docs/geode-native-docs/regions/region-attributes.html.md.erb b/docs/geode-native-docs/regions/region-attributes.html.md.erb
index 7045abd..30e5cc2 100644
--- a/docs/geode-native-docs/regions/region-attributes.html.md.erb
+++ b/docs/geode-native-docs/regions/region-attributes.html.md.erb
@@ -38,6 +38,33 @@ Shortcut attributes are a convenience only. They are named attributes that <%=va
has already stored for you. You can override their settings by storing new attributes with the same
`id` as the predefined attributes.
+### <a id="region-shortcuts_shortcut-attribute-options"></a>Shortcut Attribute Options
+
+You can select the most common region attributes settings from `RegionShortcut`, the predefined named region attributes.
+
+This section provides an overview of the options available in the region shortcut settings.
+
+**Communication with Servers and Data Storage**
+
+`PROXY`
+> does not store data in the client cache, but connects the region to the servers for data requests and updates, interest registrations, and so on.
+
+`CACHING_PROXY`
+> stores data in the client cache and connects the region to the servers for data requests and updates, interest registrations, and so on.
+
+`LOCAL`
+> stores data in the client cache and does not connect the region to the servers. This is a client-side-only region.
+
+**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.
+
+### <a id="customizing-region-attributes"></a>Customizing Region Attributes
+
You can also create custom region attributes and store them with an identifier for later
retrieval. Both types of stored attributes are referred to as named region attributes. You can
create and store your attribute settings through the API or in the `cache.xml` file.
@@ -72,31 +99,6 @@ In this example, the modified region shortcut is saved to the cache using the re
<region name="newTestRegion" refid="Caching_Proxy_With_Listener"/>
```
-### <a id="region-shortcuts_shortcut-attribute-options"></a>Shortcut Attribute Options
-
-You can select the most common region attributes settings from `RegionShortcut`, the predefined named region attributes.
-
-This section provides an overview of the options available in the region shortcut settings.
-
-**Communication with Servers and Data Storage**
-
-`PROXY`
-> does not store data in the client cache, but connects the region to the servers for data requests and updates, interest registrations, and so on.
-
-`CACHING_PROXY`
-> stores data in the client cache and connects the region to the servers for data requests and updates, interest registrations, and so on.
-
-`LOCAL`
-> stores data in the client cache and does not connect the region to the servers. This is a client-side-only region.
-
-**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.
-
## <a id="immutable-region-attributes"></a>Immutable Region Attributes
Attributes that are immutable (fixed) after region creation govern storage location, data
@@ -111,6 +113,7 @@ This table lists the immutable attributes and their default settings.
| [InitialCapacity](#initial-capacity) | 16 (entries) |
| [LoadFactor](#load-factor) | 0.75 |
| [ConcurrencyLevel](#concurrency-level) | 16 |
+| [ConcurrencyChecksEnabled](#concurrency-checks-enabled) | true |
| [DiskPolicy](../client-cache/disk-policy.html#disk-policy) | |
| [PersistenceManager](../client-cache/persistence-manager.html#persistence-manager) | NULL |
| [PartitionResolver](../client-cache/application-plugins.html#application-plugins_partitionresolver) | |
@@ -135,26 +138,12 @@ If `CachingEnabled` is false (no caching), an `IllegalStateException` is thrown
- [LruEntriesLimit](#lru-entries-limit)
- [DiskPolicy](../client-cache/disk-policy.html#disk-policy)
-The following declaration enables caching for the region:
-
-``` pre
-<region-attributes caching-enabled="true">
-</region-attributes>
-```
-
### <a id="initial-capacity"></a>InitialCapacity
Use this attribute, together with the `LoadFactor` attribute, to set the initial parameters on the
underlying hashmap that stores region entries. This is the number of entries that the region map
will be ready to hold when it is created.
-This declaration sets the region's initial capacity to `10000`:
-
-``` pre
-<region-attributes initial-capacity="10000">
-</region-attributes>
-```
-
### <a id="load-factor"></a>LoadFactor
Use this attribute, together with the `InitialCapacity` attribute, to set the initial parameters on
@@ -162,38 +151,37 @@ the underlying hashmap that stores region entries. When the number of entries in
`LoadFactor` times current capacity, the capacity is increased and the map is rehashed. You get the
best performance if you configure a properly sized region at the start and do not have to rehash it.
-This declaration sets the region's load factor to `0.75` :
-
-``` pre
-<region-attributes load-factor="0.75">
-</region-attributes>
-```
-
### <a id="concurrency-level"></a>ConcurrencyLevel
This attribute estimates the maximum number of application threads that concurrently access a region
entry at one time. This attribute helps optimize the use of system resources and reduce thread
contention.
-The following declaration sets the region's `ConcurrencyLevel` to `16`:
-
-``` pre
-<region-attributes concurrency-level="16">
-</region-attributes>
-```
-
**Note:**
When `CachingEnabled` is `false`, do not set the `ConcurrencyLevel` attribute. An `IllegalStateException` is thrown if the attribute is set.
+### <a id="concurrency-checks-enabled"></a>ConcurrencyChecksEnabled
+
+This attribute determines whether members perform checks to provide consistent handling for
+concurrent or out-of-order updates to distributed regions.
+
+A client cache can disable consistency checking for a region even if server caches enable
+consistency checking for the same region. This configuration (with checking disabled on the client
+region but enabled on the server region) ensures that the client sees all events for the region, but it
+does not prevent the client cache region from becoming out-of-sync with the server cache.
+
+See [Region Consistency](consistency-checking-in-regions.html) for more information.
+
## <a id="mutable-region-attributes"></a>Mutable Region Attributes
Mutable region attributes identify expiration and cache listener, cache writer and cache loader
-actions that are run from the defining client. The following table lists the mutable attributes that
-generally can be modified after region creation by using the `AttributesMutator` for the region.
+actions that are run from the defining client. The mutable attributes listed in the following table
+generally can be set by `RegionFactory` before region creation or modified after region creation by
+using the `AttributesMutator` for the region.
| Mutable Region Attribute | Default Setting |
|----------------------------------------------------------------------------------------------|-----------------|
-| [Expiration attributes](expiration-attributes.html#expiration-attributes). | no expiration |
+| [Expiration attributes](../client-cache/expiration-attributes.html#expiration-attributes) | no expiration |
| [LruEntriesLimit](#lru-entries-limit) | 0 (no limit) |
| [CacheLoader](../client-cache/application-plugins.html#application-plugins_cacheloader) | |
| [CacheWriter](../client-cache/application-plugins.html#application-plugins_cachewriter) | |
@@ -203,25 +191,6 @@ generally can be modified after region creation by using the `AttributesMutator`
See [AttributesMutator](../client-cache/application-plugins.html#application-plugins_attributesmutator) for
information about using `AttributesMutator` with cache listeners, cache loaders, and cache writers.
-### <a id="concurrency-checks-enabled"></a>ConcurrencyChecksEnabled
-
-This attribute determines whether members perform checks to provide consistent handling for
-concurrent or out-of-order updates to distributed regions.
-
-A client cache can disable consistency checking for a region even if server caches enable
-consistency checking for the same region. This configuration ensures that the client sees all events
-for the region, but it does not prevent the client cache region from becoming out-of-sync with the
-server cache.
-
-Optionally enable concurrency checks for the region. Example:
-
-``` pre
-<region-attributes concurrency-checks-enabled="true">
-</region-attributes>
-```
-
-See [Region Consistency](consistency-checking-in-regions.html) for more information.
-
### <a id="lru-entries-limit"></a>LruEntriesLimit
This attribute sets the maximum number of entries to hold in a caching region. When the capacity of
@@ -236,15 +205,6 @@ entries to disk.
If you use disk data overflow to supplement memory for your data cache, make sure you have enough disk space to store the data.
-This declaration limits the region to 20,000 entries:
-
-``` pre
-<region-attributes lru-entries-limit="20000"
- initial-capacity="20000"
- load-factor="1">
-</region-attributes>
-```
-
Evicted entries can be destroyed or moved to disk as an extension of the cache. See [DiskPolicy](../client-cache/disk-policy.html#disk-policy).
**Note:**
diff --git a/docs/geode-native-docs/regions/regions.html.md.erb b/docs/geode-native-docs/regions/regions.html.md.erb
index 751850b..b1887a7 100644
--- a/docs/geode-native-docs/regions/regions.html.md.erb
+++ b/docs/geode-native-docs/regions/regions.html.md.erb
@@ -148,8 +148,7 @@ listeners with the ability to abort operations. If a cache writer is defined for
in the distributed system, it is invoked before the region is explicitly destroyed.
Region invalidation and destruction can cause other user-defined application plug-ins to be invoked
-as well. These plug-ins are described in detail in the [Overview of Application
-Plug-Ins](application-plugins.html#application-plugins__section_8FEB62EEC7A042E0A85E0FEDC9F71597).
+as well. These plug-ins are described in detail in [Application Plug-Ins](../client-cache/application-plugins.html).
Whether carried out explicitly or through expiration activities, invalidation and destruction cause event notification.
@@ -162,15 +161,15 @@ You can use `Cache::getRegion` to retrieve a reference to a specified region.
A region name *cannot* contain these characters:
-- <
-- >
-- :
-- "
-- /
-- \\
-- |
-- ?
-- \*
+| Ineligible Character description | Ineligible Character |
+|----------------------------------|----------------------|
+| angle brackets | < > |
+| colon | : |
+| quote | `"` |
+| forward slash and back slash | / \\ |
+| pipe (vertical bar) | | |
+| question mark | ? |
+| asterisk | \* |
## <a id="getting-region-size"></a>Getting the Region Size
--
To stop receiving notification emails like this one, please contact
dbarnes@apache.org.