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 35b0bb7 GEODE-5672: Geode Native Docs: explain how to connect apps to
the server (#344)
35b0bb7 is described below
commit 35b0bb79aa9c91b8101eab556efa03dac063f79e
Author: Dave Barnes <[email protected]>
AuthorDate: Thu Sep 6 15:35:53 2018 -0700
GEODE-5672: Geode Native Docs: explain how to connect apps to the server
(#344)
* GEODE-5672: Geode Native Docs: explain how to connect apps to the server
---
.../configuring/configuration.html.md.erb | 23 -----
.../getting-started-nc-client.html.md.erb | 113 ++++++++++++++++++---
2 files changed, 98 insertions(+), 38 deletions(-)
diff --git a/docs/geode-native-docs/configuring/configuration.html.md.erb
b/docs/geode-native-docs/configuring/configuration.html.md.erb
index 76ed266..c452c42 100644
--- a/docs/geode-native-docs/configuring/configuration.html.md.erb
+++ b/docs/geode-native-docs/configuring/configuration.html.md.erb
@@ -59,29 +59,6 @@ XML equivalent:
</region>
```
-## <a id="config_connecting_to_the_server"></a>Connecting to the Server
-
-Example of connecting to the Server, taken from the put-get-remove example.
-
-``` cpp
-int main(int argc, char** argv) {
-
- auto cacheFactory = CacheFactory(); // instantiate
cache factory
- cacheFactory.set("log-level", "none"); // set cache
log-level characteristics
- auto cache = cacheFactory.create(); // create cache
- auto poolFactory = cache.getPoolManager().createFactory(); // instantiate
pool factory
-
- poolFactory.addLocator("localhost", 10334); // add locator
to pool factory
- auto pool = poolFactory.create("pool"); // create a pool
called "pool" that knows where the server is
- auto regionFactory = cache.createRegionFactory(RegionShortcut::PROXY); //
instantiate region factory with PROXY characteristics
- auto region = regionFactory.setPoolName("pool").create("example_userinfo");
// create a connection to the region "example_userinfo" on the server
-
- ... // do something
-
- cache.close(); // clean up
-}
-```
-
## Tables of properties
See [System Properties](sysprops.html) for a list of system properties that
can be configured
diff --git
a/docs/geode-native-docs/getting-started/getting-started-nc-client.html.md.erb
b/docs/geode-native-docs/getting-started/getting-started-nc-client.html.md.erb
index ca1d263..187f340 100644
---
a/docs/geode-native-docs/getting-started/getting-started-nc-client.html.md.erb
+++
b/docs/geode-native-docs/getting-started/getting-started-nc-client.html.md.erb
@@ -5,27 +5,103 @@ title: Getting Started with the Native Library
To use the <%=vars.product_name%> Native Library for developing
<%=vars.product_name%> client applications:
- Obtain a distribution of the Native library and install it on your
development platform.
+- Set up your development environment with the tools you need, such as a
compiler and an OpenSSL security library.
- Establish access to a new or existing <%=vars.product_name%> cluster.
-- Set up your development environment with the tools you need, such as a
compiler, a dynamic loader, and an OpenSSL security library.
- Write your client application using the <%=vars.product_name%> native
library to interact with the <%=vars.product_name%> server.
+## <a id="set_up_dev_environment"></a>Set Up Your Development Environment
+
+Whether you are developing a C++ or .NET application, you will need some
essential tools, such as a compiler and a linker.
+Your compiler must have access to the Native Client header files, and the
linker must have access to the Native Client libraries.
+The header files and libraries are located in the Native Client installation
directory (referred to as *native-client-dir* elsewhere in this guide).
+
## <a id="establish_cluster_access"></a>Establish Access to a
<%=vars.product_name%> Cluster
As you develop your application, you will need access to a
<%=vars.product_name%> cluster.
Your client application connects to a <%=vars.product_name%> cluster by
specifying the address (host name
or IP address) and port number of one or more locators, and the name of a
region that also exists
on the cluster.
+The client API establishes a pool of these network connections for your client
application to use.
You can choose whether to use a large, remote, production-quality cluster, a
small, local,
development cluster, or something in-between, such as a testing or
experimental lab installation.
-Refer to the [_<%=vars.product_name%> User's
Guide_](/serverman/about_<%=vars.product_name.downcase%>.html) for instructions
on configuring and starting the cluster.
+In the _<%=vars.product_name%> User's Guide_,
+see [Configuring and Running a
Cluster](/serverman/configuring/chapter_overview.html)
+and [Client/Server
Configuration](/serverman/topologies_and_comm/cs_configuration/chapter_overview.html)
for instructions on setting up and starting the cluster for a client/server
configuration.
-## <a id="set_up_dev_environment"></a>Set Up Your Development Environment
+### <a id="connecting_to_server"></a>Connecting to the Server
+
+To connect to a server, your application must follow these steps:
+
+1. Instantiate a `CacheFactory`, setting characteristics of interest (for
example, `log-level`).
+1. Create a cache and use it to instantiate a `PoolFactory`, specifying the
hostname and port for the server locator.
+1. Create a named pool of network connections.
+1. Instantiate a region of the desired type (usually CACHING_PROXY or PROXY)
and connect it by name to its counterpart on the server.
+
+Once the connection pool and the shared region are in place, your client
application is ready to share data with the server.
+
+**C++ Example**
+
+This example of connecting to the server is taken from the C++
`put-get-remove` example.
+
+Instantiate a `CacheFactory` and set its characteristics:
+
+``` cpp
+ auto cacheFactory = CacheFactory(); // instantiate cache factory
+ cacheFactory.set("log-level", "none"); // set cache log-level
characteristics
+```
+
+Create a cache and use it to instantiate a `PoolFactory`:
+
+``` cpp
+ auto cache = cacheFactory.create(); // create cache
+ auto poolFactory = cache.getPoolManager().createFactory(); // instantiate
pool factory
+
+ poolFactory.addLocator("localhost", 10334); // add locator
to pool factory
+```
+
+Create a named pool of network connections, and instantiate a region of the
desired type:
+
+``` cpp
+ auto pool = poolFactory.create("pool"); // create a pool
called "pool" that knows where the server is
+ auto regionFactory = cache.createRegionFactory(RegionShortcut::PROXY); //
instantiate region factory with PROXY characteristics
+ auto region = regionFactory.setPoolName("pool").create("example_userinfo");
// create a connection to the region "example_userinfo" on the server
+```
+
+**.NET Example**
+
+This example of connecting to the server is taken from the .NET `PutGetRemove`
example.
+
+Instantiate a `CacheFactory` and set its characteristics:
+
+``` csharp
+ var cacheFactory = new CacheFactory() // instantiate cache factory
+ .Set("log-level", "none"); // set cache log-level
characteristics
+```
+
+Create a cache and use it to instantiate a `PoolFactory`:
+
+``` csharp
+ var cache = cacheFactory.Create(); // create cache
+
+ var poolFactory = cache.GetPoolFactory() // instantiate pool factory
+ .AddLocator("localhost", 10334); // add locator to pool factory
+```
+
+Create a named pool of network connections, and instantiate a region of the
desired type:
+
+``` csharp
+ poolFactory.Create("pool"); // create a pool called "pool"
that knows where the server is
+
+ var regionFactory = cache.CreateRegionFactory(RegionShortcut.PROXY) //
instantiate region factory with PROXY characteristics
+ .SetPoolName("pool");
+ var region = regionFactory.Create<string, string>("example_userinfo"); //
create a connection to the region "example_userinfo" on the server
+```
+
+See the _<%=vars.product_name%> User Guide_ section [Configuring a
Client/Server
System](/serverman/topologies_and_comm/cs_configuration/setting_up_a_client_server_system.html)
+for more details.
-Whether you are developing a C++ or .NET application, you will need some
essential tools, such as a compiler and a dynamic linker.
-Your compiler must have access to the Native Client header files, and the
dynamic loader must have access to the Native Client libraries.
-The header files and libraries are located in the Native Client installation
directory (referred to as *native-client-dir* elsewhere in this guide).
### <a id="app_dev_walkthroughs"></a>Application Development Walkthroughs
@@ -51,16 +127,23 @@ The directory structure resembles this hierarchy (some
entries are omitted for c
CMakeLists.txt.in
cmake/
cpp/
- BUILDING.md
- customserializable/
- customserializer/
+ BUILD-CPP-EXAMPLES.md
+ CMakeLists.txt
+ dataserializable/
+ pdxserializable/
+ pdxserializer/
put-get-remove/
+ remotequery/
dotnet/
- AuthInitialize/
- PdxAutoSerializer/
- PutGetRemove/
- README.md
-
-See the `BUILDING.md` or `README.md` file in each directory for detailed
instructions on building
+ AuthInitialize/
+ BUILD-DOTNET-EXAMPLES.md
+ CMakeLists.txt
+ DataSerializableCs/
+ PdxAutoSerializer/
+ PdxSerializableCs/
+ PutGetRemove/
+ RemoteQueryCs/
+
+See the `BUILD-platform-EXAMPLES.md` or `README.md` file in each directory for
detailed instructions on building
and executing the examples, and read the source code to understand how the
examples are constructed.
