http://git-wip-us.apache.org/repos/asf/geode/blob/de0559be/geode-docs/docs/geode-native-book/master_middleman/source/subnavs/gemfire-nc-nav.erb ---------------------------------------------------------------------- diff --git a/geode-docs/docs/geode-native-book/master_middleman/source/subnavs/gemfire-nc-nav.erb b/geode-docs/docs/geode-native-book/master_middleman/source/subnavs/gemfire-nc-nav.erb new file mode 100644 index 0000000..6d0b752 --- /dev/null +++ b/geode-docs/docs/geode-native-book/master_middleman/source/subnavs/gemfire-nc-nav.erb @@ -0,0 +1,985 @@ +<div id="sub-nav" class="js-sidenav nav-container" role="navigation"> + <a class="sidenav-title" data-behavior="SubMenuMobile"> + Doc Index</a> + <div class="nav-content"> + <ul> + <li> + <a href="/native/about_native_client_users_guide.html">Pivotal GemFire Native Client 9.0 Documentation</a> + </li> + <li> + <a href="/native/relnotes/release_notes_nc-9.0.html">Pivotal GemFire Native Client 9.0 Release Notes</a> + </li> + </ul> + <ul> + <li> + <a href="/native/getting_started/system_requirements/gemfire_native_client_requirements.html">Supported Configurations and System Requirements</a> + </li> + </ul> + <ul> + <li class="has_submenu"> + <a href="/native/introduction/native-client-intro.html">Getting Started with a Native Client</a> + <ul> + <li> + <a href="/native/introduction/native-client-overview.html">About the Native Client</a> + </li> + <li class="has_submenu"> + <a href="/native/introduction/install-overview.html">Installing the Native Client</a> + <ul> + <li> + <a href="/native/introduction/install-unix.html">Installing on Linux or Solaris</a> + </li> + <li> + <a href="/native/introduction/install-windows.html">Installing on Windows</a> + </li> + <li> + <a href="/native/introduction/uninstall.html">Uninstalling the Native Client</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/introduction/running-client-apps.html">Running Native Client Applications</a> + <ul> + <li> + <a href="/native/introduction/developing-linux.html">Developing C++ Programs on Linux</a> + </li> + <li> + <a href="/native/introduction/developing-solaris.html">Developing C++ Programs on Solaris</a> + </li> + <li> + <a href="/native/introduction/developing-windows.html">Developing C++ Programs on Windows</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/introduction/quickstart.html">QuickStart Examples</a> + <ul> + <li> + <a href="/native/introduction/quickstart.html#ConfiguringQSE">Configuring the QuickStart Environment</a> + </li> + <li> + <a href="/native/introduction/quickstart.html#AboutQSE">About the QuickStart Examples</a> + </li> + <li> + <a href="/native/introduction/quickstart.html#RunningQSE">Running the Examples</a> + </li> + <li> + <a href="/native/introduction/quickstart.html#BuildingQSE">Building the Examples</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/setting-properties/chapter-overview.html">Setting System Properties</a> + <ul> + <li class="has_submenu"> + <a href="/native/setting-properties/config-overview.html">Configuring the Native Client and Cache Server</a> + <ul> + <li> + <a href="/native/setting-properties/native-client-config.html">Native Client Configuration</a> + </li> + <li> + <a href="/native/setting-properties/cache-server-config.html">Cache Server Configuration</a> + </li> + <li> + <a href="/native/setting-properties/attribute-def-priority.html">Attribute Definition Priority</a> + </li> + <li> + <a href="/native/gfcpp.properties/gfcpp.properties_search_path.html">Search Path for Multiple gfcpp.properties Files</a> + </li> + <li> + <a href="/native/gfcpp.properties/overriding_gfcpp.properties.html">Overriding gfcpp.properties Settings</a> + </li> + <li> + <a href="/native/setting-properties/define-programmatically.html">Defining Properties Programmatically</a> + </li> + </ul> + </li> + <li> + <a href="/native/setting-properties/attributes-gfcpp.html">Attributes in gfcpp.properties</a> + </li> + <li class="has_submenu"> + <a href="/native/gfcpp.properties/chapter_overview.html">gfcpp.properties Example File</a> + <ul> + <li> + <a href="/native/gfcpp.properties/default_sample_file.html">Using the Default Sample File</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/client-cache/chapter-overview.html">Configuring the Native Client Cache</a> + <ul> + <li class="has_submenu"> + <a href="/native/client-cache/caches.html">Caches</a> + <ul> + <li> + <a href="/native/client-cache/overview-client-cache.html">About the Native Client Cache</a> + </li> + <li> + <a href="/native/client-cache/caching-apis.html">Cache APIs</a> + </li> + <li> + <a href="/native/client-cache/cache-ownership.html">Local, Remote, and Distributed Caches</a> + </li> + <li> + <a href="/native/client-cache/create-access-cache.html">Creating and Accessing a Cache</a> + </li> + <li> + <a href="/native/client-cache/closing-cache.html">Closing the Cache</a> + </li> + </ul> + </li> + <li> + <a href="/native/cache-init-file/chapter-overview.html">Cache Initialization File (cache.xml)</a> + </li> + <li class="has_submenu"> + <a href="/native/client-cache/regions.html">Regions</a> + <ul> + <li> + <a href="/native/client-cache/declarative-region-creation.html">Declarative Region Creation</a> + </li> + <li> + <a href="/native/client-cache/programmatic-region-creation.html">Programmatic Region Creation</a> + </li> + <li> + <a href="/native/client-cache/invalidating-region.html">Invalidating and Destroying Regions</a> + </li> + <li> + <a href="/native/client-cache/region-access.html">Region Access</a> + </li> + <li> + <a href="/native/client-cache/getting-the-region-size.html">Getting the Region Size</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/client-cache/entries.html">Region Entries</a> + <ul> + <li> + <a href="/native/client-cache/requirements-for-distrib.html">Entry Distribution Requirements</a> + </li> + <li> + <a href="/native/client-cache/registering-interest-for-entries.html">Registering Interest for Entries</a> + </li> + <li> + <a href="/native/client-cache/using-serverkeys-to-retrieve.html">Using serverKeys to Retrieve a Set of Region Keys</a> + </li> + <li> + <a href="/native/client-cache/adding-entries-to-cache.html">Adding Entries to the Cache</a> + </li> + <li> + <a href="/native/client-cache/updating-entries.html">Updating Entries</a> + </li> + <li> + <a href="/native/client-cache/accessing-entries.html">Accessing Entries</a> + </li> + <li> + <a href="/native/client-cache/invalidating-cached-entries.html">Invalidating or Destroying Cached Entries</a> + </li> + <li> + <a href="/native/client-cache/notification-for-operations.html">Notification for Operations</a> + </li> + </ul> + </li> + <li> + <a href="/native/client-cache/consistency_checking_in_regions.html">Region Consistency</a> + </li> + <li class="has_submenu"> + <a href="/native/client-cache/region-attributes.html">Region Attributes</a> + <ul> + <li> + <a href="/native/client-cache/specify-region-attributes.html">Specifying Region Attributes</a> + </li> + <li> + <a href="/native/client-cache/region-shortcuts.html">RegionShortcuts</a> + </li> + <li> + <a href="/native/client-cache/region-attributes-desc.html">Mutable and Immutable Region Attributes</a> + </li> + <li> + <a href="/native/client-cache/caching-enabled.html">CachingEnabled</a> + </li> + <li> + <a href="/native/client-cache/initial-capacity.html">InitialCapacity</a> + </li> + <li> + <a href="/native/client-cache/load-factor.html">LoadFactor</a> + </li> + <li> + <a href="/native/client-cache/concurrency-level.html">ConcurrencyLevel</a> + </li> + <li> + <a href="/native/client-cache/concurrency-checks-enabled.html">ConcurrencyChecksEnabled</a> + </li> + <li> + <a href="/native/client-cache/lru-entries-limit.html">LruEntriesLimit</a> + </li> + <li> + <a href="/native/client-cache/disk-policy.html">DiskPolicy</a> + </li> + <li> + <a href="/native/client-cache/persistence-manager.html">PersistenceManager</a> + </li> + <li> + <a href="/native/client-cache/expiration-attributes.html">Specifying Expiration Attributes</a> + </li> + </ul> + </li> + <li> + <a href="/native/client-cache/application-plugins.html">Application Plug-ins</a> + </li> + <li class="has_submenu"> + <a href="/native/client-cache/cache-management.html">Cache Management</a> + <ul> + <li> + <a href="/native/client-cache/client-to-server-connection.html">Client-to-Server Connection Process</a> + </li> + <li> + <a href="/native/client-cache/controlling-cache-size.html">Controlling Cache Size</a> + </li> + <li> + <a href="/native/client-cache/managing-lifetime-cached-object.html">Managing the Lifetime of a Cached Object</a> + </li> + <li> + <a href="/native/client-cache/using-thread-safety.html">Using Thread Safety in Cache Management</a> + </li> + <li> + <a href="/native/client-cache/troubleshooting.html">Troubleshooting</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/cpp-caching-api/cpp-caching-api.html">Pivotal GemFire Native Client C++ API</a> + <ul> + <li> + <a href="/native/cpp-caching-api/gfe-cpp-api.html">About the Native Client C++ API</a> + </li> + <li> + <a href="/native/cpp-caching-api/creating-cache.html">Creating a Cache</a> + </li> + <li> + <a href="/native/cpp-caching-api/creating-region.html">Creating a Proxy Client-Side Region</a> + </li> + <li> + <a href="/native/cpp-caching-api/add-entry-to-cache.html">Adding an Entry to the Cache</a> + </li> + <li> + <a href="/native/cpp-caching-api/accessing-entry.html">Accessing an Entry</a> + </li> + <li> + <a href="/native/cpp-caching-api/removing-entry.html">Removing an Entry</a> + </li> + <li class="has_submenu"> + <a href="/native/cpp-caching-api/serialization_overview.html">Serializing Data</a> + <ul> + <li> + <a href="/native/cpp-caching-api/region_data_requiring_serialization.html">Region Data Requiring Serialization</a> + </li> + <li> + <a href="/native/cpp-caching-api/serialization_options.html">Data Serialization Options</a> + </li> + <li class="has_submenu"> + <a href="/native/cpp-caching-api/pdx_serialization.html">Serializing Data with PDX Serialization</a> + <ul> + <li> + <a href="/native/cpp-caching-api/using_pdxserializer.html">Serialize Your Domain Objects with PdxSerializer and PdxWrapper</a> + </li> + <li class="has_submenu"> + <a href="/native/cpp-caching-api/pdxserializable_interface.html">Serialize Using the PdxSerializable Class</a> + <ul> + <li> + <a href="/native/cpp-caching-api/performing_ops_with_pdx_object.html">Performing put, get, and localDestroy Operations with a PDX Domain Object</a> + </li> + </ul> + </li> + <li> + <a href="/native/cpp-caching-api/pdx_auto_serialization.html">Using Automatic PDX Serialization</a> + </li> + <li> + <a href="/native/cpp-caching-api/using_pdxinstance.html">Programming Your Application to Use PdxInstances</a> + </li> + <li> + <a href="/native/cpp-caching-api/pdx_ignore_unread_fields.html">Configuring PDX to Ignore Unread Fields During Deserialization</a> + </li> + <li> + <a href="/native/cpp-caching-api/using_pdxinstancefactory.html">Using PdxInstanceFactory to Create PdxInstances</a> + </li> + <li> + <a href="/native/cpp-caching-api/using_enum_type_with_pdx.html">Using C++ Enum Type with PDX Serialization</a> + </li> + <li> + <a href="/native/cpp-caching-api/pdx_with_delta_propagation.html">Using PDX Serialization with Delta Propagation</a> + </li> + </ul> + </li> + <li> + <a href="/native/cpp-caching-api/serialization_using_serializable.html">Serializing Data with the Serializable Interface</a> + </li> + <li> + <a href="/native/cpp-caching-api/object-graphs.html">Serializing Object Graphs</a> + </li> + <li> + <a href="/native/cpp-caching-api/data-as-blob.html">Serializing and Accessing Data as a Blob</a> + </li> + </ul> + </li> + <li> + <a href="/native/cpp-caching-api/user-defined-objects.html">Implementing User-Defined Objects in Java Clients</a> + </li> + <li> + <a href="/native/cpp-caching-api/using-custom-class.html">Using a Custom Class</a> + </li> + <li> + <a href="/native/cpp-caching-api/creating-new-statistics.html">Creating New Statistics</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/dotnet-caching-api/dotnet-caching-api.html">Pivotal GemFire Native Client .NET API</a> + <ul> + <li class="has_submenu"> + <a href="/native/dotnet-caching-api/csharp-dotnet-api.html">About the Native Client .NET API</a> + <ul> + <li> + <a href="/native/dotnet-caching-api/csharp-dotnet-naming-conventions.html">.NET Naming and Usage Conventions</a> + </li> + <li class="has_submenu"> + <a href="/native/dotnet-caching-api/primary-apis-cache-generic.html">Primary APIs</a> + <ul> + <li> + <a href="/native/dotnet-caching-api/cache-apis.html">Cache APIs</a> + </li> + <li> + <a href="/native/dotnet-caching-api/region-entry-apis.html">Region and Entry APIs</a> + </li> + <li> + <a href="/native/dotnet-caching-api/data-serialization-apis.html">Data Serialization APIs</a> + </li> + <li> + <a href="/native/dotnet-caching-api/event-handling-apis.html">Event Handling APIs</a> + </li> + <li> + <a href="/native/dotnet-caching-api/other-apis.html">Property Collections and Logging APIs</a> + </li> + </ul> + </li> + </ul> + </li> + <li> + <a href="/native/dotnet-caching-api/cpp-class-to-dotnet-class-mappings.html">C++ Class to .NET Class Mappings</a> + </li> + <li> + <a href="/native/dotnet-caching-api/java-to-dotnet-type-mapping.html">Java to .NET Type Mapping Table</a> + </li> + <li> + <a href="/native/dotnet-caching-api/object-lifetimes.html">Object Lifetimes</a> + </li> + <li class="has_submenu"> + <a href="/native/dotnet-caching-api/dotnet-application-domains.html">.NET Application Domains</a> + <ul> + <li> + <a href="/native/dotnet-caching-api/problem-scenarios.html">Problem Scenarios</a> + </li> + </ul> + </li> + <li> + <a href="/native/dotnet-caching-api/creating-a-cache.html">Creating a Cache</a> + </li> + <li> + <a href="/native/dotnet-caching-api/creating-a-region.html">Creating a Region</a> + </li> + <li> + <a href="/native/dotnet-caching-api/dotnet-adding-entry-to-cache.html">Adding an Entry to the Cache</a> + </li> + <li> + <a href="/native/dotnet-caching-api/dotnet-accessing-an-entry.html">Accessing an Entry</a> + </li> + <li> + <a href="/native/dotnet-caching-api/removing-entry.html">Removing an Entry</a> + </li> + <li class="has_submenu"> + <a href="/native/dotnet-caching-api/dotnet-data-serialization.html">Data Serialization</a> + <ul> + <li> + <a href="/native/dotnet-caching-api/dotnet-data-serialization-options.html">Data Serialization Options</a> + </li> + <li class="has_submenu"> + <a href="/native/dotnet-caching-api/dotnet-pdx-serialization.html">Serialize with PDX Serialization</a> + <ul> + <li> + <a href="/native/dotnet-caching-api/dotnet-pdx-serialization-features.html">GemFire PDX Serialization Features</a> + </li> + <li> + <a href="/native/dotnet-caching-api/dotnet-pdx-autoserializer.html">Serialize Using the GemFire PDX Autoserializer</a> + </li> + <li> + <a href="/native/dotnet-caching-api/extending-pdx-autoserializer.html">Extend the PDX Autoserializer</a> + </li> + <li> + <a href="/native/dotnet-caching-api/serializing-domain-objects.html">Serialize Your Domain Objects with IPdxSerializer</a> + </li> + <li> + <a href="/native/dotnet-caching-api/serialize-using-ipdxserializable.html">Serialize Using the GemFire IPdxSerializable Interface</a> + </li> + <li> + <a href="/native/dotnet-caching-api/programming-ipdxinstance.html">Program Your Application to Use IPdxInstance</a> + </li> + <li> + <a href="/native/dotnet-caching-api/using-ipdxinstancefactory.html">Use the IPdxInstanceFactory to Create IPdxInstances</a> + </li> + <li> + <a href="/native/dotnet-caching-api/mapping-dotnet-domain-type-names.html">Map .NET Domain Type Names to PDX Type Names with IPdxTypeMapper</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/dotnet-caching-api/serialize-using-igfserializable.html">Serialize with the GemFire IGFSerializable Interface</a> + <ul> + <li> + <a href="/native/dotnet-caching-api/serializable-types.html">Generic and Custom Serializable Types</a> + </li> + <li> + <a href="/native/dotnet-caching-api/how-igfserializable-works.html">How Serialization Works with IGFSerializable</a> + </li> + <li> + <a href="/native/dotnet-caching-api/implementing-igfserializable.html">Implement the IGFSerializable Interface</a> + </li> + <li> + <a href="/native/dotnet-caching-api/registering-the-type.html">Register the Type</a> + </li> + </ul> + </li> + <li> + <a href="/native/dotnet-caching-api/custom-class-igfserializable.html">Using a Custom Class With IGFSerializable</a> + </li> + </ul> + </li> + <li> + <a href="/native/dotnet-caching-api/application-callbacks.html">Application Callbacks</a> + </li> + <li> + <a href="/native/dotnet-caching-api/simple-csharp-example.html">A Simple C# Example</a> + </li> + <li class="has_submenu"> + <a href="/native/dotnet-caching-api/troubleshooting-dotnet-applications.html">Troubleshooting .NET Applications</a> + <ul> + <li> + <a href="/native/dotnet-caching-api/resolving-the-error.html">Resolving the Error</a> + </li> + <li> + <a href="/native/dotnet-caching-api/private-assembly.html">Using GemStone.GemFire.Cache.dll As a Private Assembly</a> + </li> + <li> + <a href="/native/dotnet-caching-api/implementing-shared-assembly.html">Implementing the Shared Assembly</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/preserving-data/preserving-data.html">Preserving Data</a> + <ul> + <li class="has_submenu"> + <a href="/native/preserving-data/high-availability-client-server.html">High Availability for Client-Server Communication</a> + <ul> + <li> + <a href="/native/preserving-data/configuring-nc-ha.html">Configuring Native Clients for High Availability</a> + </li> + <li> + <a href="/native/preserving-data/sending-periodic-ack.html">Sending Periodic Acknowledgment</a> + </li> + </ul> + </li> + <li> + <a href="/native/preserving-data/using-queue-conflation.html">Enabling Queue Conflation to Improve Update Performance</a> + </li> + <li class="has_submenu"> + <a href="/native/preserving-data/durable-client-messaging.html">Durable Client Messaging</a> + <ul> + <li> + <a href="/native/preserving-data/durable-client-messaging-req.html">Durable Client Messaging Requirements</a> + </li> + <li class="has_submenu"> + <a href="/native/preserving-data/client-side-config.html">Client-Side Configuration</a> + <ul> + <li> + <a href="/native/preserving-data/configuring-durable-nc.html">Configuring a Durable Native Client</a> + </li> + <li> + <a href="/native/preserving-data/config-durable-interest-keys.html">Configuring Durable Interest in Keys</a> + </li> + <li> + <a href="/native/preserving-data/config-durable-reconnect.html">Configuring Durable Client Reconnection</a> + </li> + </ul> + </li> + <li> + <a href="/native/preserving-data/sending-cache-ready-message.html">Sending Cache Ready Messages to the Server</a> + </li> + <li> + <a href="/native/preserving-data/disconnecting-from-server.html">Disconnecting from the Server</a> + </li> + <li class="has_submenu"> + <a href="/native/preserving-data/durable-client-life-cycle.html">Life Cycle of a Durable Client</a> + <ul> + <li> + <a href="/native/preserving-data/initial-operation.html">Initial Operation</a> + </li> + <li> + <a href="/native/preserving-data/disconnection.html">Disconnection</a> + </li> + <li> + <a href="/native/preserving-data/reconnection.html">Reconnection</a> + </li> + <li> + <a href="/native/preserving-data/durable-message-replay.html">Durable Message Replay</a> + </li> + <li> + <a href="/native/preserving-data/app-ops-during-int-reg.html">Application Operations During Interest Registration</a> + </li> + </ul> + </li> + <li> + <a href="/native/preserving-data/impl-cache-listeners-durable-clients.html">Implementing Cache Listeners for Durable Clients</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/security/overviewsecurity.html">Security</a> + <ul> + <li class="has_submenu"> + <a href="/native/security/overviewauthentication.html">Authentication</a> + <ul> + <li> + <a href="/native/security/authentication-levels.html">Process and Multiuser Authentication</a> + </li> + <li> + <a href="/native/security/systempropsforauth.html">Configuring Credentials for Authentication</a> + </li> + <li> + <a href="/native/security/authforcacheserver.html">Configuring Authentication by the Cache Server</a> + </li> + <li> + <a href="/native/security/handling-serv-auth-errors.html">Server Authentication Errors</a> + </li> + <li class="has_submenu"> + <a href="/native/security/createsecureconnregionservice.html">Creating Multiple Secure User Connections</a> + <ul> + <li> + <a href="/native/security/caveatregionservice.html">Requirements and Caveats for RegionService</a> + </li> + </ul> + </li> + <li> + <a href="/native/security/LDAPserverauth.html">Using an LDAP Server for Client Authentication</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/security/encrypted-auth.html">Encrypted Authentication</a> + <ul> + <li> + <a href="/native/security/overviewencryptcred.html">Encrypt Credentials with Diffe-Hellman</a> + </li> + <li> + <a href="/native/security/PKCS.html">Using PKCS for Encrypted Authentication</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/security/overviewclientauthorization.html">Client Authorization</a> + <ul> + <li> + <a href="/native/security/config-clientauthorization.html">Configuring Client Authorization</a> + </li> + <li> + <a href="/native/security/postopauthorization.html">Post-Operative Authorization</a> + </li> + <li> + <a href="/native/security/usingoperationcontext.html"> + Determining Pre- or Post-Operation Authorization</a> + </li> + </ul> + </li> + <li> + <a href="/native/security/security-systemprops.html">Security-Related System Properties (gfcpp.properties)</a> + </li> + <li class="has_submenu"> + <a href="/native/security/overviewsslclientserver.html">SSL Client/Server Communication</a> + <ul> + <li> + <a href="/native/security/ssl-setup.html">Set Up OpenSSL</a> + </li> + <li> + <a href="/native/security/limitations.html">Limitations</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/remote-querying/remote-querying.html">Remote Querying</a> + <ul> + <li class="has_submenu"> + <a href="/native/remote-querying/91-quickintro/1-quickintro-overview.html">Remote Querying Basics</a> + <ul> + <li> + <a href="/native/remote-querying/91-quickintro/4-quickintro-exampleportfolioregion.html">Examples Data and Class Definitions</a> + </li> + <li> + <a href="/native/remote-querying/91-quickintro/2-quickintro-querycodeexamples.html">Executing a Query from the Native Client</a> + </li> + <li> + <a href="/native/remote-querying/91-quickintro/41-quickintro-query-portfolioregion.html">Querying the Portfolios Region</a> + </li> + <li> + <a href="/native/remote-querying/91-quickintro/42-quickintro-modify-cachecontents.html">Modifying Cache Contents</a> + </li> + <li> + <a href="/native/remote-querying/94-indexes/indexes-overview.html">Creating Indexes</a> + </li> + <li> + <a href="/native/remote-querying/91-quickintro/3-quickintro-requirements.html">Remote Querying Requirements</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/remote-querying/93-querystrings/1-querystring-overview.html">Using Query Strings in the Native Client</a> + <ul> + <li class="has_submenu"> + <a href="/native/remote-querying/93-querystrings/3-from-clause.html">FROM Clause</a> + <ul> + <li> + <a href="/native/remote-querying/93-querystrings/3a-iterator-variables.html">Using Iterator Variables</a> + </li> + <li> + <a href="/native/remote-querying/93-querystrings/3b-importing-using-object-classes.html">Importing and Using Object Classes</a> + </li> + <li> + <a href="/native/remote-querying/93-querystrings/3c-predefined-class-types.html">Predefined Class Types</a> + </li> + <li> + <a href="/native/remote-querying/93-querystrings/3d-specify-object-types.html">Specifying the Object Types of FROM Clause Collections</a> + </li> + </ul> + </li> + <li> + <a href="/native/remote-querying/93-querystrings/6-select-projection-list.html">SELECT Projection List</a> + </li> + <li> + <a href="/native/remote-querying/93-querystrings/7-select-statement-query-results.html">SELECT Statement Query Results</a> + </li> + <li> + <a href="/native/remote-querying/93-querystrings/4-where-clause.html">WHERE Clause</a> + </li> + <li> + <a href="/native/remote-querying/93-querystrings/5-joins.html">Joins</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/remote-querying/92-querylanguage/2-accessingdata.html">Accessing Cached Data</a> + <ul> + <li> + <a href="/native/remote-querying/92-querylanguage/21-basic-region-access.html">Basic Region Access</a> + </li> + <li> + <a href="/native/remote-querying/92-querylanguage/23-attribute-visibility.html">Attribute Visibility</a> + </li> + <li> + <a href="/native/remote-querying/92-querylanguage/22-drilldown-modify-query-scope.html">Modifying Query Scope</a> + </li> + <li> + <a href="/native/remote-querying/92-querylanguage/24-nested-query-scope.html">Nested Query Scopes</a> + </li> + <li> + <a href="/native/remote-querying/92-querylanguage/25-when-names-cant-resolve.html">When Names Cannot Be Resolved</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/remote-querying/93-querystrings/8-query-language-elements.html">Query Language Elements</a> + <ul> + <li> + <a href="/native/remote-querying/93-querystrings/8a-method-invocation.html">Method Invocation</a> + </li> + <li> + <a href="/native/remote-querying/93-querystrings/8b-query-lang-literals.html">Query Language Literals Supported by Native Client</a> + </li> + <li> + <a href="/native/remote-querying/93-querystrings/8c-type-conversions.html">Type Conversions</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/remote-querying/95-remotequeryapi/1-remote-query-api-overview.html">Remote Query API</a> + <ul> + <li> + <a href="/native/remote-querying/95-remotequeryapi/2-create-manage-queries.html">Creating and Managing Queries</a> + </li> + <li> + <a href="/native/remote-querying/95-remotequeryapi/3-query-result-sets.html">Query Result Sets</a> + </li> + <li> + <a href="/native/remote-querying/96-progexamples/2-query-code-examples-resultset.html">Query Code Samples Returning ResultSet</a> + </li> + <li> + <a href="/native/remote-querying/96-progexamples/3-query-code-examples-structset.html">Query Code Samples Returning StructSet</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/continuous-querying/continuous-querying.html">Continuous Querying</a> + <ul> + <li> + <a href="/native/continuous-querying/1-how-cont-query-works.html">How Continuous Querying Works</a> + </li> + <li class="has_submenu"> + <a href="/native/continuous-querying/5-implementing-cq.html">Implementing a Continuous Query</a> + <ul> + <li> + <a href="/native/continuous-querying/2-config-for-continuous-querying.html">Configuring Your System for Continuous Querying</a> + </li> + <li> + <a href="/native/continuous-querying/5a-writing-cq.html">Writing the Continuous Query</a> + </li> + <li> + <a href="/native/continuous-querying/5b-writing-cq-listener.html">Writing the CQ Listener or CQ Status Listener</a> + </li> + <li> + <a href="/native/continuous-querying/5c-cq-event-object.html">CqEvent Object</a> + </li> + <li> + <a href="/native/continuous-querying/5e-running-cq-code.html">Running the Continuous Query Code</a> + </li> + <li> + <a href="/native/continuous-querying/5f-cq-execution-options.html">CQ Execution Options</a> + </li> + <li> + <a href="/native/continuous-querying/5d-when-error-occurs.html">When an Error Occurs in a Running CQ</a> + </li> + </ul> + </li> + <li> + <a href="/native/continuous-querying/6-managing-cqs.html">Managing Continuous Queries</a> + </li> + <li> + <a href="/native/continuous-querying/3-native-client-cq-api.html">CQ API and Main Features</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/connection-pools/connection-pools.html">Using Connection Pools</a> + <ul> + <li class="has_submenu"> + <a href="/native/connection-pools/client-load-balancing.html">How Client Load Balancing Works</a> + <ul> + <li> + <a href="/native/connection-pools/about-server-locators.html">Server Locators</a> + </li> + <li> + <a href="/native/connection-pools/about-connection-pools.html">Connection Pools</a> + </li> + <li> + <a href="/native/connection-pools/discovering-locators-dynamically.html">Discovering Locators Dynamically</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/connection-pools/configuring-pools.html">Configuring Pools</a> + <ul> + <li> + <a href="/native/connection-pools/native-client-pool-api.html">Native Client Pool API</a> + </li> + <li> + <a href="/native/connection-pools/configuring-pools-attributes-example.html">Pool Configuration Example and Settings</a> + </li> + <li> + <a href="/native/connection-pools/subscription-properties.html">Subscription Properties</a> + </li> + <li> + <a href="/native/connection-pools/running-connection-pool-code.html">Running the Connection Pool Code</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/transactions/transactions.html">Transactions</a> + <ul> + <li> + <a href="/native/transactions/how-native-client-xacts-work.html">How Native Client Transactions Work</a> + </li> + <li> + <a href="/native/transactions/running-native-client-xact.html">Running a Native Client Transaction</a> + </li> + <li> + <a href="/native/transactions/suspend-resume-xacts.html">Suspending and Resuming Transactions</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/function-execution/function-execution.html">Function Execution</a> + <ul> + <li> + <a href="/native/function-execution/data-aware-function-execution.html">Understanding Data-Aware Function Routing</a> + </li> + <li> + <a href="/native/function-execution/how-functions-execute.html">How Functions Execute</a> + </li> + <li class="has_submenu"> + <a href="/native/function-execution/executing-functions.html">Executing Functions</a> + <ul> + <li> + <a href="/native/function-execution/running-function.html">Running the Function</a> + </li> + <li> + <a href="/native/function-execution/handling-function-results.html">Programming to Get Function Results</a> + </li> + <li> + <a href="/native/function-execution/solutions-use-cases.html">Solutions and Use Cases</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/delta-propagation/delta-propagation.html">Delta Propagation</a> + <ul> + <li> + <a href="/native/delta-propagation/how-delta-propagation-works.html">How Delta Propagation Works</a> + </li> + <li> + <a href="/native/delta-propagation/delta-propagation-api.html">Delta Propagation API</a> + </li> + <li> + <a href="/native/delta-propagation/delta-propagation-properties.html">Cloning</a> + </li> + <li> + <a href="/native/delta-propagation/implementing-delta-propagation.html">Implementing Delta Propagation</a> + </li> + <li> + <a href="/native/delta-propagation/performance.html">Exceptions and Limitations</a> + </li> + <li> + <a href="/native/delta-propagation/delta-propagation-examples.html">Examples of Delta Propagation</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/programming-examples/programming-examples.html">Programming Examples</a> + <ul> + <li> + <a href="/native/programming-examples/native-client-region.html">Declaring a Native Client Region</a> + </li> + <li> + <a href="/native/programming-examples/csharp-example.html">API Programming Example â C#</a> + </li> + <li> + <a href="/native/programming-examples/cpp-example.html">API Programming Example â C++</a> + </li> + <li class="has_submenu"> + <a href="/native/programming-examples/serialization-overview.html">Data Serialization Examples</a> + <ul> + <li> + <a href="/native/programming-examples/serialization-cpp.html">C++ Serialization Example</a> + </li> + <li> + <a href="/native/programming-examples/serialization-csharp.html">C# Serialization Example</a> + </li> + <li> + <a href="/native/programming-examples/serialization-java.html">Java Serialization Example</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/type_mappings/chapter_overview.html">Interoperability of Language Classes and Types</a> + <ul> + <li class="has_submenu"> + <a href="/native/type_mappings/cpp-class-to-dotnet-class-mappings.html">C++ Class to .NET Class Mappings</a> + <ul> + <li> + <a href="/native/cpp-caching-api/type_interoperability.html">Interoperability of C++ Types When Using PDX Serialization</a> + </li> + </ul> + </li> + <li> + <a href="/native/type_mappings/java-to-dotnet-type-mapping.html">Java to .NET Type Mapping Table</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/system-statistics/chapter_overview.html">System Statistics</a> + <ul> + <li> + <a href="/native/system-statistics/sampling_statistics.html">Sampling Statistics</a> + </li> + <li class="has_submenu"> + <a href="/native/system-statistics/system_performance_statistics.html">System Performance Statistics</a> + <ul> + <li> + <a href="/native/system-statistics/region_statistics.html">Region Statistics</a> + </li> + <li> + <a href="/native/system-statistics/cache_performance_statistics.html">Cache Performance Statistics</a> + </li> + <li> + <a href="/native/system-statistics/continuous_query_statistics.html">Continuous Query Statistics</a> + </li> + <li> + <a href="/native/system-statistics/cq_service_statistics.html">CQ Service Statistics</a> + </li> + <li> + <a href="/native/system-statistics/pool_statistics.html">Pool Statistics</a> + </li> + <li> + <a href="/native/system-statistics/delta_statistics.html">Delta Statistics</a> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/system-statistics/operating_system_statistics.html">Operating System Statistics</a> + <ul> + <li> + <a href="/native/system-statistics/linux_os_statistics.html">Linux Process Statistics</a> + </li> + <li> + <a href="/native/system-statistics/solaris_os_statistics.html">Solaris Process Statistics</a> + </li> + <li> + <a href="/native/system-statistics/windows_os_statistics.html">Windows Process Statistics</a> + </li> + </ul> + </li> + </ul> + </li> + <li class="has_submenu"> + <a href="/native/sqlite-persistence/chapter_overview.html">Installing the SQLite Persistence Manager</a> + <ul> + <li> + <a href="/native/sqlite-persistence/linux_install.html">Linux Installation</a> + </li> + <li> + <a href="/native/sqlite-persistence/solaris_install.html">Solaris Installation</a> + </li> + <li> + <a href="/native/sqlite-persistence/windows_install.html">Windows Installation</a> + </li> + </ul> + </li> + <li> + <a href="/native/glossary.html">Glossary</a> + </li> + </ul> + </div> +</div>
http://git-wip-us.apache.org/repos/asf/geode/blob/de0559be/geode-docs/docs/geode-native-book/redirects.rb ---------------------------------------------------------------------- diff --git a/geode-docs/docs/geode-native-book/redirects.rb b/geode-docs/docs/geode-native-book/redirects.rb new file mode 100644 index 0000000..bb7d9b7 --- /dev/null +++ b/geode-docs/docs/geode-native-book/redirects.rb @@ -0,0 +1,14 @@ +r301 %r{/gfmanual/(.*)}, 'http://gemfire.docs.pivotal.io/docs-gemfire/$1' +r301 %r{/geodeman/(.*)}, 'http://gemfire.docs.pivotal.io/docs-gemfire/latest/$1' +r301 %r{/releases/latest/javadoc/(.*)}, 'http://data-docs-samples.cfapps.io/docs-gemfire/821/javadocs/japi/$1' +r301 %r{/docs-gemfire/latest/cpp_api/(.*)}, 'http://data-docs-samples.cfapps.io/docs-gemfire/821/cpp_api/$1' +r301 %r{/docs-gemfire/latest/net_api/(.*)}, 'http://data-docs-samples.cfapps.io/docs-gemfire/821/net_api/$1' +r302 '/index-820.html', 'http://gemfire82.docs.pivotal.io/index.html' +r302 '/index-810.html', 'http://gemfire81.docs.pivotal.io/index.html' +r302 '/index-800.html', 'http://gemfire80.docs.pivotal.io/index.html' +r302 '/index-702.html', 'http://gemfire702.docs.pivotal.io/7.0.2/index.html' +r302 '/index-earlier.html', 'https://www.vmware.com/support/pubs/vfabric-gemfire.html' +r302 '/bugnotes/KnownIssuesGemFire810.html', 'http://gemfire81.docs.pivotal.io/bugnotes/KnownIssuesGemFire810.html' +r302 '/bugnotes/KnownIssuesPulseGemFire810.html', 'http://gemfire81.docs.pivotal.io/bugnotes/KnownIssuesPulseGemFire810.html' +r302 '/bugnotes/KnownIssuesGemFire800.html', 'http://gemfire81.docs.pivotal.io/bugnotes/KnownIssuesGemFire800.html' +r302 '/bugnotes/KnownIssuesPulseGemFire800.html', 'http://gemfire81.docs.pivotal.io/bugnotes/KnownIssuesPulseGemFire800.html' http://git-wip-us.apache.org/repos/asf/geode/blob/de0559be/geode-docs/docs/geode-native-docs/README.md ---------------------------------------------------------------------- diff --git a/geode-docs/docs/geode-native-docs/README.md b/geode-docs/docs/geode-native-docs/README.md new file mode 100644 index 0000000..c19a92a --- /dev/null +++ b/geode-docs/docs/geode-native-docs/README.md @@ -0,0 +1 @@ +# docs-gemfire-nc http://git-wip-us.apache.org/repos/asf/geode/blob/de0559be/geode-docs/docs/geode-native-docs/about_native_client_users_guide.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/docs/geode-native-docs/about_native_client_users_guide.html.md.erb b/geode-docs/docs/geode-native-docs/about_native_client_users_guide.html.md.erb new file mode 100644 index 0000000..707e343 --- /dev/null +++ b/geode-docs/docs/geode-native-docs/about_native_client_users_guide.html.md.erb @@ -0,0 +1,85 @@ +--- +title: Pivotal GemFire® Native Client 9.0 Documentation +--- + +Published January 5, 2017 + +This documentation provides step-by-step procedures for installation, configuration, and development of native clients. + +- **[Pivotal GemFire Native Client 9.0 Release Notes](relnotes/release_notes_nc-9.0.html)** + +- **[Supported Configurations and System Requirements](getting_started/system_requirements/gemfire_native_client_requirements.html)** + +- **[C++ and .NET API](http://gemfire-apis.docs.pivotal.io)** + +- **[Getting Started with a Native Client](introduction/native-client-intro.html)** + + This section gives you a conceptual overview of the native client. It shows you how to install the product, build native client applications on various platforms, and run the product examples. + +- **[Setting System Properties](setting-properties/chapter-overview.html)** + + *Setting System Properties* describes how to configure Apache Geode native clients and cache servers to participate in a distributed system. + +- **[Configuring the Native Client Cache](client-cache/chapter-overview.html)** + + *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. + +- **[Pivotal GemFire Native Client C++ API](cpp-caching-api/cpp-caching-api.html)** + + This section describes the primary classes, and usage conventions for the native client C++ API. It demonstrates how to use the API to create caches and perform data serialization. The C++ API documentation is available at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io). + +- **[Pivotal GemFire Native Client .NET API](dotnet-caching-api/dotnet-caching-api.html)** + + This section describes the primary classes, usage conventions, and C++ to .NET class mappings of the native client .NET API. It demonstrates how to use the API to create caches and perform data serialization. The .NET API documentation is available at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io). + +- **[Preserving Data](preserving-data/preserving-data.html)** + + A server may preserve the data queued and intended to be sent to a native client, such that the data is not discarded if communication between the server and native client is disrupted. Preservation prevents message loss, which can cause a native client to have inconsistent data. Redundant queues and a high availability server implementation may further ensure that queued data is not lost. + +- **[Security](security/overviewsecurity.html)** + + *Security* describes how to implement the security framework for the Geode native client, including authentication, authorization, ecryption, and SSL client/server communication. + +- **[Remote Querying](remote-querying/remote-querying.html)** + + *Remote Querying* documents remote querying from the native client to the Geode cache server. Using examples and procedures, it describes how to use the APIs to run queries against cached data; work with query strings in the native client; create and manage queries; and create indexes. + +- **[Continuous Querying](continuous-querying/continuous-querying.html)** + + *Continuous Querying* describes how to implement continuous querying in the Apache Geode native client so that C++ and .NET clients can run queries against events in the Geode cache server region. It also describes main features and the native client CQ API. + +- **[Using Connection Pools](connection-pools/connection-pools.html)** + + *Using Connection Pools* describes how connection pools achieve load balancing for the client and describes how to configure connection pools as server locators or as a list of servers. + +- **[Transactions](transactions/transactions.html)** + + *Transactions* describes how transactions work on the client side. It provides examples for running, suspending, and resuming transactions. + +- **[Function Execution](function-execution/function-execution.html)** + + *Function Execution* describes how you can execute application functions to achieve linear scalability. It explains how function execution works and lists specific use cases. + +- **[Delta Propagation](delta-propagation/delta-propagation.html)** + + *Delta Propagation* describes how deltas (updates to data) are propagated and how to implement delta propagation. It also analyzes performance limitations. + +- **[Programming Examples](programming-examples/programming-examples.html)** + + This chapter provides a set of programming examples to help you understand the Geode native client API. + +- **[Interoperability of Language Classes and Types](type_mappings/chapter_overview.html)** + + *Interoperability of Language Classes and Types* provides a table that maps C++ class methods to corresponding .NET class methods and a table that maps Java types to .NET types. + +- **[System Statistics](system-statistics/chapter_overview.html)** + + *System Statistics* provides information on the Pivotal GemFire installation and includes standard statistics for caching and distribution activities. + +- **[Installing the SQLite Persistence Manager](sqlite-persistence/chapter_overview.html)** + + *Installing the SQLite Persistence Manager* describes how to download, build and install the SQLite database libraries for use with disk overflow. + +- **[Glossary](glossary.html)** + + This glossary defines terms used in the documentation. http://git-wip-us.apache.org/repos/asf/geode/blob/de0559be/geode-docs/docs/geode-native-docs/cache-init-file/cache-dtd.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/docs/geode-native-docs/cache-init-file/cache-dtd.html.md.erb b/geode-docs/docs/geode-native-docs/cache-init-file/cache-dtd.html.md.erb new file mode 100644 index 0000000..edf11ba --- /dev/null +++ b/geode-docs/docs/geode-native-docs/cache-init-file/cache-dtd.html.md.erb @@ -0,0 +1,267 @@ +--- +title: Native Client Cache XML DTD +--- + +The contents of the cache initialization file must conform to the data type definitions in `gfcpp-cache8000.dtd`. + +The `gfcpp-cache8000.dtd` file is in the `productDir/dtd` directory of your native client installation. + +The following example presents the file `gfcpp-cache8000.dtd`, which defines the XML used by the native client for declarative caching. 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. + +``` pre +<?xml version="1.0" encoding="UTF-8"?> + +<!-- + +This is the XML DTD for the GemFire Native Client declarative caching XML file. + +The contents of a declarative XML file correspond to APIs found in the +Gemfire Native Client product, more specifically in the +Cache.hpp and Region.hpp files in the product include directory + +A declarative caching XML file is used to populate a Cache +when it is created. + +--> + + +<!-- +The "client-cache" element is the root element of the declarative cache file. +This element configures a GemFire Native Client Cache and describes the +root regions it contains, if any. +--> + +<!ELEMENT client-cache (pool*, root-region*, region*, pdx?)> +<!ATTLIST client-cache + endpoints CDATA #IMPLIED + redundancy-level CDATA #IMPLIED +> + +<!-- +A "locator" element specifies the host and port that a server locator is listening on +--> +<!ELEMENT locator EMPTY> +<!ATTLIST locator + host CDATA #REQUIRED + port CDATA #REQUIRED +> + +<!-- +A "server" element specifies the host and port that a cache server is listening on +--> +<!ELEMENT server EMPTY> +<!ATTLIST server + host CDATA #REQUIRED + port CDATA #REQUIRED +> + +<!-- A "pdx" element specifies the properties related to pdx types --> +<!ELEMENT pdx EMPTY> +<!ATTLIST + ignore-unread-fields (false | true) #IMPLIED + read-serialized (false | true) #IMPLIED + > + +<!-- +A "pool" element specifies a client-server connection pool. +--> +<!ELEMENT pool (locator+|server+)> +<!ATTLIST pool + free-connection-timeout CDATA #IMPLIED + load-conditioning-interval CDATA #IMPLIED + min-connections CDATA #IMPLIED + max-connections CDATA #IMPLIED + retry-attempts CDATA #IMPLIED + idle-timeout CDATA #IMPLIED + ping-interval CDATA #IMPLIED + name CDATA #REQUIRED + read-timeout CDATA #IMPLIED + server-group CDATA #IMPLIED + socket-buffer-size CDATA #IMPLIED + subscription-enabled (false | true) #IMPLIED + subscription-message-tracking-timeout CDATA #IMPLIED + subscription-ack-interval CDATA #IMPLIED + subscription-redundancy CDATA #IMPLIED + statistic-interval CDATA #IMPLIED + pr-single-hop-enabled (true | false) #IMPLIED + thread-local-connections (false | true) #IMPLIED + multiuser-authentication (false | true) #IMPLIED +> + +<!-- +A root-region" element describes a root region whose entries and +subregions will be stored in memory. +Note that the "name" attribute specifies the simple name of the region; +it cannot contain a "/". +--> + +<!ELEMENT root-region (region-attributes?, region*)> +<!ATTLIST root-region + name CDATA #REQUIRED +> + + +<!-- +A "region" element describes a region (and its entries) in GemFire +Native Client cache. Note that the "name" attribute specifies the simple +name of the region; it cannot contain a "/". +--> + +<!ELEMENT region (region-attributes?, region*)> +<!ATTLIST region + name CDATA #REQUIRED + refid CDATA #IMPLIED +> + + + +<!-- +A "region-attributes" element describes the attributes of a region to +be created. For more details see the RegionFactory header in the +product include directory +--> + +<!ELEMENT region-attributes ((region-time-to-live | + region-idle-time | entry-time-to-live | entry-idle-time | + partition-resolver | + cache-loader | cache-listener | cache-writer | persistence-manager)*)> +<!ATTLIST region-attributes + caching-enabled (true | TRUE | false | FALSE) #IMPLIED + cloning-enabled (true | TRUE | false | FALSE) #IMPLIED + scope (local | distributed-no-ack | distributed-ack ) #IMPLIED + initial-capacity CDATA #IMPLIED + load-factor CDATA #IMPLIED + concurrency-level CDATA #IMPLIED + lru-entries-limit CDATA #IMPLIED + disk-policy (none | overflows | persist ) #IMPLIED + endpoints CDATA #IMPLIED + client-notification (true | TRUE | false | FALSE) #IMPLIED + pool-name CDATA #IMPLIED + concurrency-checks-enabled (true | TRUE | false | FALSE) #IMPLIED + id CDATA #IMPLIED + refid CDATA #IMPLIED +> + + + + + + +<!-- +A "region-time-to-live" element specifies a Region's time to live +--> + +<!ELEMENT region-time-to-live (expiration-attributes)> + + + +<!-- +A "region-idle-time" element specifies a Region's idle time +--> + +<!ELEMENT region-idle-time (expiration-attributes)> + + + +<!-- +A "entry-time-to-live" element specifies a Region's entries' time to +live +--> + +<!ELEMENT entry-time-to-live (expiration-attributes)> + + + +<!-- +A "entry-idle-time" element specifies a Region's entries' idle time +--> + +<!ELEMENT entry-idle-time (expiration-attributes)> + + +<!-- +A "properties" element specifies a persistence properties +--> + +<!ELEMENT properties (property*)> + +<!-- +An "expiration-attributes" element describes expiration +--> + +<!ELEMENT expiration-attributes EMPTY> +<!ATTLIST expiration-attributes + timeout CDATA #REQUIRED + action (invalidate | destroy | local-invalidate | local-destroy) #IMPLIED +> + + + +<!-- +A "cache-loader" element describes a region's CacheLoader +--> + +<!ELEMENT cache-loader EMPTY > +<!ATTLIST cache-loader + library-name CDATA #IMPLIED + library-function-name CDATA #REQUIRED +> + + + +<!-- +A "cache-listener" element describes a region's CacheListener +--> + +<!ELEMENT cache-listener EMPTY> +<!ATTLIST cache-listener + library-name CDATA #IMPLIED + library-function-name CDATA #REQUIRED +> + + + +<!-- +A "cache-writer" element describes a region's CacheListener +--> + +<!ELEMENT cache-writer EMPTY> +<!ATTLIST cache-writer + library-name CDATA #IMPLIED + library-function-name CDATA #REQUIRED +> + +<!-- +A "partition-resolver" element describes a region's PartitionResolver +--> + +<!ELEMENT partition-resolver EMPTY> +<!ATTLIST partition-resolver + library-name CDATA #IMPLIED + library-function-name CDATA #REQUIRED +> + +<!-- +A "persistence-manager" element describes a region's persistence feature +--> + +<!ELEMENT persistence-manager (properties)> +<!ATTLIST persistence-manager + library-name CDATA #IMPLIED + library-function-name CDATA #REQUIRED +> + + + +<!-- +A "property" element describes a persistence property +--> + +<!ELEMENT property EMPTY> +<!ATTLIST property + name CDATA #REQUIRED + value CDATA #REQUIRED +> +``` + + http://git-wip-us.apache.org/repos/asf/geode/blob/de0559be/geode-docs/docs/geode-native-docs/cache-init-file/chapter-overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/docs/geode-native-docs/cache-init-file/chapter-overview.html.md.erb b/geode-docs/docs/geode-native-docs/cache-init-file/chapter-overview.html.md.erb new file mode 100644 index 0000000..8e2ef58 --- /dev/null +++ b/geode-docs/docs/geode-native-docs/cache-init-file/chapter-overview.html.md.erb @@ -0,0 +1,66 @@ +--- +title: Cache Initialization File (cache.xml) +--- + +To ease the task of managing the structure of the cache, you can define the default Geode cache structure in an XML-based initialization file. + +# Cache Initialization File Basics + +The contents of the cache initialization file are used to populate or update a cache. + +This occurs when a cache server starts up, when a client application explicitly creates its cache, or when a client explicitly loads a new structure into an existing cache. + +The initialization file can have any name, but is generally referred to as `cache.xml`. Both client applications and cache servers can use an optional `cache.xml` file to ease the initialization process. + +## <a id="file-basics__section_E54BF7911C224016B822768B537FA464" class="no-quick-link"></a>File Contents + +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 `gfcpp.properties` file for the native client. For details about the `gfcpp.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). + +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. + +``` 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";> +<!-- Sample cache.xml file --> +<!-- Example Declarative Cache Initialization with cache.xml --> +<cache> + <pool name="examplePool" subscription-enabled="true"> + <server host="localhost" port="24680" /> + </pool> + <region name="root1" refid="CACHING_PROXY"> + <region-attributes pool-name="examplePool" + initial-capacity="25" + load-factor="0.32" + concurrency-level="10" + lru-entries-limit="35"> + <region-idle-time> + <expiration-attributes timeout="20" action="destroy"/> + </region-idle-time> + <entry-idle-time> + <expiration-attributes timeout="10" action="invalidate"/> + </entry-idle-time> + <region-time-to-live> + <expiration-attributes timeout="5" action="local-destroy"/> + </region-time-to-live> + <entry-time-to-live> + <expiration-attributes timeout="10" action="local-invalidate"/> + </entry-time-to-live> + </region-attributes> + </region> +</cache> +```
