This is an automated email from the ASF dual-hosted git repository. igodwin 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 8b159e3 GEODE-4340: Fix README.md for examples 8b159e3 is described below commit 8b159e356f572396b931c2925b02a94c30247954 Author: Michael Martell <mmart...@pivotal.io> AuthorDate: Fri Mar 8 10:40:59 2019 -0800 GEODE-4340: Fix README.md for examples * Updated references to example names and directories to match previous changes * Applied template for consistent formatting and wording Co-authored-by: Mike Martell <mmart...@pivotal.io> Co-authored-by: Blake Bender <bben...@pivotal.io> --- examples/cpp/authinitialize/README.md | 28 +++++---- examples/cpp/continuousquery/README.md | 24 ++++---- examples/cpp/dataserializable/README.md | 15 ++--- examples/cpp/functionexecution/README.md | 12 ++-- examples/cpp/pdxserializable/README.md | 18 +++--- examples/cpp/pdxserializer/README.md | 16 ++--- examples/cpp/putgetremove/README.md | 20 +++---- examples/cpp/remotequery/README.md | 22 +++---- examples/cpp/sslputget/README.md | 38 +++++++++--- examples/cpp/transaction/README.md | 6 +- examples/dotnet/authinitialize/README.md | 18 +++--- examples/dotnet/continuousquery/README.md | 16 ++--- examples/dotnet/dataserializable/README.md | 18 +++--- examples/dotnet/functionexecution/README.md | 14 ++--- examples/dotnet/pdxautoserializer/README.md | 18 +++--- examples/dotnet/pdxserializable/README.md | 16 ++--- examples/dotnet/putgetremove/README.md | 17 +++--- examples/dotnet/remotequery/README.md | 16 ++--- examples/dotnet/sslputget/README.md | 55 ++++++++++++----- examples/dotnet/transaction/README.md | 91 ++++++++++++++--------------- 20 files changed, 260 insertions(+), 218 deletions(-) diff --git a/examples/cpp/authinitialize/README.md b/examples/cpp/authinitialize/README.md index 8c5826a..b732b13 100644 --- a/examples/cpp/authinitialize/README.md +++ b/examples/cpp/authinitialize/README.md @@ -1,5 +1,5 @@ -# AuthInitialize Example -This example shows how to create and register a custom `AuthIntialize` authentication +# authinitialize example +This example shows how to create and register a custom `authinitialize` authentication handler on the client that authenticates against a server that was started with the corresponding authenticator. ## Prerequisites @@ -9,13 +9,13 @@ handler on the client that authenticates against a server that was started with * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `authinitialize` directory in your example workspace. +1. From a command shell, set the current directory to the `authinitialize` build directory in your example workspace. ```console - $ cd workspace/examples/cpp/authinitialize + $ cd workspace/examples/build/cpp/authinitialize ``` -2. Run the `startserver` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -34,17 +34,15 @@ handler on the client that authenticates against a server that was started with ```console $ ./startserver.sh ``` + +1. Execute `cpp-authinitialize`, expect the following output: -3. Execute `authinitialize`, expect the following output: + ExampleAuthInitialize::ExampleAuthInitialize called + ExampleAuthInitialize::getCredentials called + a = 1 + b = 2 - ```text - ExampleAuthInitialize::ExampleAuthInitialize called - ExampleAuthInitialize::getCredentials called - a = 1 - b = 2 - ``` - -4. Run the `stopserver` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -62,4 +60,4 @@ handler on the client that authenticates against a server that was started with ```console $ ./stopserver.sh - ``` \ No newline at end of file + ``` diff --git a/examples/cpp/continuousquery/README.md b/examples/cpp/continuousquery/README.md index fdb2076..379d860 100644 --- a/examples/cpp/continuousquery/README.md +++ b/examples/cpp/continuousquery/README.md @@ -1,4 +1,4 @@ -# Continuous Query Example +# continuousquery example This is a simple example showing how to create a continuous query. ## Prerequisites @@ -8,24 +8,24 @@ This is a simple example showing how to create a continuous query. * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `continuousquery` directory in your example workspace. +1. From a command shell, set the current directory to the `continuousquery` build directory in your example workspace. ```console - $ cd workspace/examples/cpp/continuousquery + $ cd workspace/examples/build/cpp/continuousquery ``` -2. Run the `startserver` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver` script to start the Geode cluster with authentication and create a region. For Windows cmd: - ```console - $ powershell.exe -File startserver.ps1 - ``` + ```console + $ powershell.exe -File startserver.ps1 + ``` For Windows Powershell: ```console - $ startserver.ps1 + $ startserver.ps1 ``` For Bash: @@ -33,8 +33,8 @@ This is a simple example showing how to create a continuous query. ```console $ ./startserver.sh ``` - -3. Execute `continuousquery`, expect the following output: + +1. Execute `cpp-continuousquery`, expect the following output: Executing continuous query Create orders @@ -47,7 +47,7 @@ This is a simple example showing how to create a continuous query. MyCqListener::OnEvent called with DESTROY, key[Order6], value is nullptr close called -4. Run the `stopserver` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -65,4 +65,4 @@ This is a simple example showing how to create a continuous query. ```console $ ./stopserver.sh - ``` \ No newline at end of file + ``` diff --git a/examples/cpp/dataserializable/README.md b/examples/cpp/dataserializable/README.md index 96287b2..4eecb3b 100644 --- a/examples/cpp/dataserializable/README.md +++ b/examples/cpp/dataserializable/README.md @@ -1,4 +1,4 @@ -# DataSerializable example +# dataserializable example This is a simple example showing how to register for serialization of custom objects using the DataSerializable class. ## Prerequisites @@ -8,13 +8,13 @@ This is a simple example showing how to register for serialization of custom obj * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `dataserializable` directory in your example workspace. +1. From a command shell, set the current directory to the `dataserializable` build directory in your example workspace. ```console - $ cd workspace/examples/cpp/dataserializable + $ cd workspace/examples/build/cpp/dataserializable ``` -2. Run the `startserver` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -33,8 +33,8 @@ This is a simple example showing how to register for serialization of custom obj ```console $ ./startserver.sh ``` - -1. Execute `dataserializable`, expect the following output: + +1. Execute `cpp-dataserializable`, expect the following output: Create orders Storing orders in the region @@ -46,7 +46,8 @@ This is a simple example showing how to register for serialization of custom obj Product Name: product y Quantity: 37 -4. Run the `stopserver` script to gracefully shutdown the Geode cluster. + +1. Run the `stopserver` script to gracefully shutdown the Geode cluster. For Windows cmd: diff --git a/examples/cpp/functionexecution/README.md b/examples/cpp/functionexecution/README.md index 57897d2..a2d0c22 100644 --- a/examples/cpp/functionexecution/README.md +++ b/examples/cpp/functionexecution/README.md @@ -1,4 +1,4 @@ -# Function-execution example +# functionexecution example This is a very simple example showing how to execute a function on the server. It creates a `Cache` using the `CacheFactory`, configures a `Pool` with a `PoolFactory`, and configures a `Region` with a `RegionFactory`. The @@ -12,13 +12,13 @@ the example app executes those functions and prints out the result set(s). * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `function-execution` directory in your example workspace. +1. From a command shell, set the current directory to the `functionexecution` build directory in your example workspace. ```console - $ cd workspace/examples/cpp/function-execution + $ cd workspace/examples/build/cpp/functionexecution ``` -2. Run the `startserver` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -38,7 +38,7 @@ the example app executes those functions and prints out the result set(s). $ ./startserver.sh ``` -3. Execute `function-execution`, expect the following output: +1. Execute `cpp-functionexecution`, expect the following output: Result count = 3 @@ -46,7 +46,7 @@ the example app executes those functions and prints out the result set(s). Result[1]=VALUE--2 Result[2]=VALUE--3 -4. Run the `stopserver` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver` script to gracefully shutdown the Geode cluster. For Windows cmd: diff --git a/examples/cpp/pdxserializable/README.md b/examples/cpp/pdxserializable/README.md index 3d00d35..bd3dd2e 100644 --- a/examples/cpp/pdxserializable/README.md +++ b/examples/cpp/pdxserializable/README.md @@ -1,4 +1,4 @@ -# PdxSerializable example +# pdxserializable example This is a simple example showing how to register for serialization of custom objects using the PdxSerializable class. ## Prerequisites @@ -8,13 +8,13 @@ This is a simple example showing how to register for serialization of custom obj * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `pdxserializable` directory in your example workspace. +1. From a command shell, set the current directory to the `pdxserializable` build directory in your example workspace. ```console - $ cd workspace/examples/cpp/pdxserializable + $ cd workspace/examples/build/cpp/pdxserializable ``` -2. Run the `startserver` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -33,8 +33,8 @@ This is a simple example showing how to register for serialization of custom obj ```console $ ./startserver.sh ``` - -3. Execute `pdxserializable`, expect the following output: + +1. Execute `cpp-pdxserializable`, expect the following output: Create orders Storing orders in the region @@ -44,9 +44,9 @@ This is a simple example showing how to register for serialization of custom obj Quantity: 23 OrderID: 2 Product Name: product y - Quantity: 37 + Quantity: 373 -4. Run the `stopserver` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -64,4 +64,4 @@ This is a simple example showing how to register for serialization of custom obj ```console $ ./stopserver.sh - ``` \ No newline at end of file + ``` diff --git a/examples/cpp/pdxserializer/README.md b/examples/cpp/pdxserializer/README.md index 2ab06f9..37cf822 100644 --- a/examples/cpp/pdxserializer/README.md +++ b/examples/cpp/pdxserializer/README.md @@ -1,4 +1,4 @@ -# PdxSerializer example +# pdxserializer example This is a simple example showing how to register for serialization of custom objects using the PdxSerializer class. ## Prerequisites @@ -8,13 +8,13 @@ This is a simple example showing how to register for serialization of custom obj * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `pdxserializer` directory in your example workspace. +1. From a command shell, set the current directory to the `pdxserializer` build directory in your example workspace. ```console - $ cd workspace/examples/cpp/pdxserializer + $ cd workspace/examples/build/cpp/pdxserializer ``` -2. Run the `startserver` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -33,8 +33,8 @@ This is a simple example showing how to register for serialization of custom obj ```console $ ./startserver.sh ``` - -3. Execute `pdxserializer`, expect the following output: + +1. Execute `cpp-pdxserializer`, expect the following output: Storing orders in the region Getting the orders from the region @@ -42,7 +42,7 @@ This is a simple example showing how to register for serialization of custom obj Product Name: product x Quantity: 42 -4. Run the `stopserver` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -60,4 +60,4 @@ This is a simple example showing how to register for serialization of custom obj ```console $ ./stopserver.sh - ``` \ No newline at end of file + ``` diff --git a/examples/cpp/putgetremove/README.md b/examples/cpp/putgetremove/README.md index 65e1fd6..b2a5cbb 100644 --- a/examples/cpp/putgetremove/README.md +++ b/examples/cpp/putgetremove/README.md @@ -1,4 +1,4 @@ -# Put-get-remove example +# putgetremove example This is a very simple example showing how to create a `Cache` using the `CacheFactory`, configure a `Pool` with a `PoolFactory`, and configure a `Region` with a `RegionFactory`. We then put, get, and remove some primitive data in the region. @@ -10,13 +10,13 @@ We then put, get, and remove some primitive data in the region. * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `put-get-remove` directory in your example workspace. +1. From a command shell, set the current directory to the `putgetremove` build directory in your example workspace. - ```consaole - $ cd workspace/examples/cpp/put-get-remove + ```console + $ cd workspace/examples/build/cpp/putgetremove ``` -2. Run the `startserver` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -35,17 +35,17 @@ We then put, get, and remove some primitive data in the region. ```console $ ./startserver.sh ``` - -3. Execute `put-get-remove` expect the following output: + +1. Execute `cpp-putgetremove`, expect the following output: Storing id and username in the region Getting the user info from the region rtimmons = Robert Timmons scharles = Sylvia Charles Removing rtimmons info from the region - rtimmons's info successfully deleted + rtimmons's info successfully deleted3 -4. Run the `stopserver` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -63,4 +63,4 @@ We then put, get, and remove some primitive data in the region. ```console $ ./stopserver.sh - ``` \ No newline at end of file + ``` diff --git a/examples/cpp/remotequery/README.md b/examples/cpp/remotequery/README.md index a1216c6..a70affe 100644 --- a/examples/cpp/remotequery/README.md +++ b/examples/cpp/remotequery/README.md @@ -1,4 +1,4 @@ -# Remote Query Example +# remotequery example This is a simple example showing how to create and execute a remote query. ## Prerequisites @@ -8,13 +8,13 @@ This is a simple example showing how to create and execute a remote query. * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `remotequery` directory in your example workspace. +1. From a command shell, set the current directory to the `remotequery` build directory in your example workspace. ```console - $ cd workspace/examples/cpp/remotequery + $ cd workspace/examples/build/cpp/remotequery ``` -2. Run the `startserver` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -24,8 +24,8 @@ This is a simple example showing how to create and execute a remote query. For Windows Powershell: - ```console - $ startserver.ps1 + ```console + $ startserver.ps1 ``` For Bash: @@ -33,8 +33,8 @@ This is a simple example showing how to create and execute a remote query. ```console $ ./startserver.sh ``` - -3. Execute `remotequery`, expect the following output: + +1. Execute `cpp-remotequery`, expect the following output: Create orders Storing orders in the region @@ -42,9 +42,9 @@ This is a simple example showing how to create and execute a remote query. The following orders have a quantity greater than 30: OrderID: 2 Product Name: product y Quantity: 37 OrderID: 4 Product Name: product z Quantity: 102 - OrderID: 6 Product Name: product z Quantity: 42 + OrderID: 6 Product Name: product z Quantity: 4 -4. Run the `stopserver` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -62,4 +62,4 @@ This is a simple example showing how to create and execute a remote query. ```console $ ./stopserver.sh - ``` \ No newline at end of file + ``` diff --git a/examples/cpp/sslputget/README.md b/examples/cpp/sslputget/README.md index 3aff841..794224a 100644 --- a/examples/cpp/sslputget/README.md +++ b/examples/cpp/sslputget/README.md @@ -1,4 +1,4 @@ -# SSLPutGet Example +# sslputget example This example illustrates how to use SSL encryption for all traffic between a client application and Apache Geode. ## Prerequisites @@ -9,13 +9,13 @@ This example illustrates how to use SSL encryption for all traffic between a cli * Install [OpenSSL](https://www.openssl.org/) ## Running -1. From a command shell, set the current directory to the `sslputget` directory in your example workspace. +1. From a command shell, set the current directory to the `sslputget` build directory in your example workspace. ```console - $ cd workspace/examples/cpp/sslputget + $ cd workspace/examples/build/cpp/sslputget ``` -2. Run the `startserver` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -34,10 +34,30 @@ This example illustrates how to use SSL encryption for all traffic between a cli ```console $ ./startserver.sh ``` + 1. Execute `cpp-sslputget`, expect the following output: + + Storing id and username in the region + Getting the user info from the region + rtimmons = Robert Timmons + scharles = Sylvia Charles + +1. Run the `stopserver` script to gracefully shutdown the Geode cluster. + + For Windows cmd: + + ```console + $ powershell.exe -File stopserver.ps1 + ``` + + For Windows Powershell: + + ```console + $ stopserver.ps1 + ``` + + For Bash: + ```console - Storing id and username in the region - Getting the user info from the region - rtimmons = Robert Timmons - scharles = Sylvia Charles - ``` \ No newline at end of file + $ ./stopserver.sh + ``` diff --git a/examples/cpp/transaction/README.md b/examples/cpp/transaction/README.md index d95062e..6dc88ca 100644 --- a/examples/cpp/transaction/README.md +++ b/examples/cpp/transaction/README.md @@ -1,4 +1,4 @@ -# Transaction example +# transaction example This is a very simple example showing how to use TransactionManager. This example shows how to begin a transaction, commit a transaction, and rollback a transaction while showing exception handling. We commit two keys and rollback adding a third key and destroying an @@ -37,7 +37,7 @@ existing key while showing how to handle exceptions. $ ./startserver.sh ``` -3. Execute `transaction`, expect the following output: +3. Execute `cpp-transaction`, expect the following output: Created cache Created region 'exampleRegion' @@ -64,4 +64,4 @@ existing key while showing how to handle exceptions. ```console $ ./stopserver.sh - ``` \ No newline at end of file + ``` diff --git a/examples/dotnet/authinitialize/README.md b/examples/dotnet/authinitialize/README.md index c726c8f..cba6ea6 100644 --- a/examples/dotnet/authinitialize/README.md +++ b/examples/dotnet/authinitialize/README.md @@ -1,5 +1,5 @@ -# AuthInitialize Example -This example shows how to create and register a custom `IAuthIntialize` authentication +# authinitialize example +This example shows how to create and register a custom `IAuthInitialize` authentication handler on the client that authenticates against a server that was started with the corresponding authenticator. ## Prerequisites @@ -9,13 +9,13 @@ handler on the client that authenticates against a server that was started with * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `AuthInitialize` directory in your example workspace. +1. From a command shell, set the current directory to the `authinitialize` directory in your example workspace. ```console - $ cd workspace/examples/dotnet/AuthInitialize + $ cd workspace/examples/build/dotnet/authinitialize ``` -2. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -29,14 +29,14 @@ handler on the client that authenticates against a server that was started with $ startserver.ps1 ``` -3. Execute `AuthInitialize.exe`, expect the following output: +1. Execute `dotnet-authinitialize.exe`, expect the following output: ExampleAuthInitialize::ExampleAuthInitialize called ExampleAuthInitialize::GetCredentials called a = 1 - b = 2 + b = -4. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -48,4 +48,4 @@ handler on the client that authenticates against a server that was started with ```console $ stopserver.ps1 - ``` \ No newline at end of file + ``` diff --git a/examples/dotnet/continuousquery/README.md b/examples/dotnet/continuousquery/README.md index c85a766..90ace18 100644 --- a/examples/dotnet/continuousquery/README.md +++ b/examples/dotnet/continuousquery/README.md @@ -1,4 +1,4 @@ -# ContinuousQuery Example +# continuousquery example This is a simple example showing how to execute a continuous query on a Goede region. ## Prerequisites @@ -8,13 +8,13 @@ This is a simple example showing how to execute a continuous query on a Goede re * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `ContinuousQueryCs` directory in your example workspace. +1. From a command shell, set the current directory to the `continuousquery` directory in your example workspace. ```console - $ cd workspace/examples/dotnet/ContinuousQueryCs + $ cd workspace/examples/build/dotnet/continuousquery ``` -2. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -28,8 +28,8 @@ This is a simple example showing how to execute a continuous query on a Goede re $ startserver.ps1 ``` -3. Execute `ContinuousQueryCs.exe`, expect the following output: - +1. Execute `dotnet-continuousquery.exe`, expect the following output: + Registering for data serialization Executing continuous query Create orders @@ -42,7 +42,7 @@ This is a simple example showing how to execute a continuous query on a Goede re MyCqListener::OnEvent(DESTROY) called with key Order6, value null MyCqListener::close called -4. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -54,4 +54,4 @@ This is a simple example showing how to execute a continuous query on a Goede re ```console $ stopserver.ps1 - ``` \ No newline at end of file + ``` diff --git a/examples/dotnet/dataserializable/README.md b/examples/dotnet/dataserializable/README.md index a0e57f7..b1c5be4 100644 --- a/examples/dotnet/dataserializable/README.md +++ b/examples/dotnet/dataserializable/README.md @@ -1,4 +1,4 @@ -# DataSerializableCs Example +# dataserializable example This is a simple example showing how to register for serialization of custom objects using the IDataSerializable class. ## Prerequisites @@ -8,13 +8,13 @@ This is a simple example showing how to register for serialization of custom obj * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `DataSerializableCs` directory in your example workspace. +1. From a command shell, set the current directory to the `dataserializable` directory in your example workspace. ```console - $ cd workspace/examples/dotnet/DataSerializableCs + $ cd workspace/examples/build/dotnet/dataserializable ``` -2. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -28,17 +28,17 @@ This is a simple example showing how to register for serialization of custom obj $ startserver.ps1 ``` -3. Execute `DataSerializableCs.exe`, expect the following output: - +1. Execute `dotnet-dataserializable.exe`, expect the following output: + Create orders Storing orders in the region Getting the orders from the region OrderID: 1 Product Name: product x Quantity: 23 - OrderID: 2 Product Name: product y Quantity: 37 + OrderID: 2 Product Name: product y Quantity: 3s -4. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -50,4 +50,4 @@ This is a simple example showing how to register for serialization of custom obj ```console $ stopserver.ps1 - ``` \ No newline at end of file + ``` diff --git a/examples/dotnet/functionexecution/README.md b/examples/dotnet/functionexecution/README.md index 92d8e16..0fc5d34 100644 --- a/examples/dotnet/functionexecution/README.md +++ b/examples/dotnet/functionexecution/README.md @@ -1,4 +1,4 @@ -# FunctionExecution Example +# functionexecution example This example illustrates how to execute server side java functions. ## Prerequisites @@ -8,13 +8,13 @@ This example illustrates how to execute server side java functions. * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `DataSerializableCs` directory in your example workspace. +1. From a command shell, set the current directory to the `functionexecution` directory in your example workspace. ```console - $ cd workspace/examples/dotnet/DataSerializableCs + $ cd workspace/examples/build/dotnet/functionexecution ``` -2. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -28,7 +28,7 @@ This example illustrates how to execute server side java functions. $ startserver.ps1 ``` -3. Execute `FunctionExecutionCs.exe`, expect the following output: +1. Execute `dotnet-functionexecution.exe`, expect the following output: Storing id and username in the region Getting the user info from the region @@ -39,7 +39,7 @@ This example illustrates how to execute server side java functions. value = Robert Timmons value = Sylvia Charles -4. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -51,4 +51,4 @@ This example illustrates how to execute server side java functions. ```console $ stopserver.ps1 - ``` \ No newline at end of file + ``` diff --git a/examples/dotnet/pdxautoserializer/README.md b/examples/dotnet/pdxautoserializer/README.md index 2e311db..625697f 100644 --- a/examples/dotnet/pdxautoserializer/README.md +++ b/examples/dotnet/pdxautoserializer/README.md @@ -1,4 +1,4 @@ -# PdxAutoSerializer Example +# pdxautoserializer example This is a simple example showing how to register for auto-serialization of custom objects using the ReflectionBasedAutoSerializer class. ## Prerequisites @@ -8,13 +8,13 @@ This is a simple example showing how to register for auto-serialization of custo * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `PdxAutoSerializerCs` directory in your example workspace. +1. From a command shell, set the current directory to the `pdxautoserializer` directory in your example workspace. ```console - $ cd workspace/examples/dotnet/PdxAutoSerializerCs + $ cd workspace/examples/build/dotnet/pdxautoserializer ``` -2. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -28,15 +28,15 @@ This is a simple example showing how to register for auto-serialization of custo $ startserver.ps1 ``` -3. Execute `PdxAutoSerializerCs.exe`, expect the following output: - +1. Execute `dotnet-pdxautoserializer.exe`, expect the following output: + Registering for reflection-based auto serialization Storing order object in the region order to put is Order: [65, Vox AC30, 11] Successfully put order, getting now... - Order key: 65 = Order: [65, Vox AC30, 11] + Order key: 65 = Order: [65, Vox AC30, 11 -4. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -48,4 +48,4 @@ This is a simple example showing how to register for auto-serialization of custo ```console $ stopserver.ps1 - ``` \ No newline at end of file + ``` diff --git a/examples/dotnet/pdxserializable/README.md b/examples/dotnet/pdxserializable/README.md index 19d773e..a40d317 100644 --- a/examples/dotnet/pdxserializable/README.md +++ b/examples/dotnet/pdxserializable/README.md @@ -1,4 +1,4 @@ -# PdxSerializable Example +# pdxserializable example This is a simple example showing how to register for serialization of custom objects using the IPDXSerializable class. ## Prerequisites @@ -8,13 +8,13 @@ This is a simple example showing how to register for serialization of custom obj * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `PdxSerializableCs` directory in your example workspace. +1. From a command shell, set the current directory to the `pdxserializable` directory in your example workspace. ```console - $ cd workspace/examples/dotnet/PdxSerializableCs + $ cd workspace/examples/build/dotnet/pdxserializable ``` -2. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -28,15 +28,15 @@ This is a simple example showing how to register for serialization of custom obj $ startserver.ps1 ``` -3. Execute `PdxSerializableCs.exe`, expect the following output: - +1. Execute `dotnet-pdxserializable.exe`, expect the following output: + Registering for data serialization Storing order object in the region order to put is Order: [65, Donuts, 12] Successfully put order, getting now... Order key: 65 = Order: [65, Donuts, 12] -4. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -48,4 +48,4 @@ This is a simple example showing how to register for serialization of custom obj ```console $ stopserver.ps1 - ``` \ No newline at end of file + ``` diff --git a/examples/dotnet/putgetremove/README.md b/examples/dotnet/putgetremove/README.md index 9fb3c7d..5f9cf2e 100644 --- a/examples/dotnet/putgetremove/README.md +++ b/examples/dotnet/putgetremove/README.md @@ -1,4 +1,4 @@ -# PutGetRemove Example +# putgetremove example This is a very simple example showing how to create a `Cache` using the `CacheFactory`, configure a `Pool` with a `PoolFactory`, and configure a `Region` with a `RegionFactory`. We then put, get, and remove some primitive data in the region. @@ -10,13 +10,13 @@ We then put, get, and remove some primitive data in the region. * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `PutGetRemove` directory in your example workspace. +1. From a command shell, set the current directory to the `putgetremove` directory in your example workspace. ```console - $ cd workspace/examples/dotnet/PutGetRemove + $ cd workspace/examples/build/dotnet/putgetremove ``` -2. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -30,8 +30,8 @@ We then put, get, and remove some primitive data in the region. $ startserver.ps1 ``` -3. Execute `PutGetRemove.exe`, expect the following output: - +1. Execute `dotnet-putgetremove.exe`, expect the following output: + Storing id and username in the region Getting the user info from the region rtimmons = Robert Timmons @@ -39,7 +39,7 @@ We then put, get, and remove some primitive data in the region. Removing rtimmons info from the region Info for rtimmons has been deleted -4. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -48,6 +48,7 @@ We then put, get, and remove some primitive data in the region. ``` For Windows Powershell: + ```console $ stopserver.ps1 - ``` \ No newline at end of file + ``` diff --git a/examples/dotnet/remotequery/README.md b/examples/dotnet/remotequery/README.md index c7d49ef..9ea2ff1 100644 --- a/examples/dotnet/remotequery/README.md +++ b/examples/dotnet/remotequery/README.md @@ -1,4 +1,4 @@ -# RemoteQuery Example +# remotequery example This is a simple example showing how to execute a query on a remote region. ## Prerequisites @@ -8,13 +8,13 @@ This is a simple example showing how to execute a query on a remote region. * Set `GEODE_HOME` to the install directory of Apache Geode ## Running -1. From a command shell, set the current directory to the `RemoteQueryCs` directory in your example workspace. +1. From a command shell, set the current directory to the `remotequery` directory in your example workspace. ```console - $ cd workspace/examples/dotnet/RemoteQueryCs + $ cd workspace/examples/build/dotnet/remotequery ``` -2. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. For Windows cmd: @@ -28,7 +28,7 @@ This is a simple example showing how to execute a query on a remote region. $ startserver.ps1 ``` -3. Execute `RemoteQueryCs.exe`, expect the following output: +1. Execute `dotnet-remotequery.exe`, expect the following output: Registering for data serialization Create orders @@ -37,9 +37,9 @@ This is a simple example showing how to execute a query on a remote region. The following orders have a quantity greater than 30: Order: [6, product z, 42] Order: [4, product z, 102] - Order: [2, product y, 37] + Order: [2, product y, 37 -4. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. For Windows cmd: @@ -51,4 +51,4 @@ This is a simple example showing how to execute a query on a remote region. ```console $ stopserver.ps1 - ``` \ No newline at end of file + ``` diff --git a/examples/dotnet/sslputget/README.md b/examples/dotnet/sslputget/README.md index 4982a9b..6212851 100644 --- a/examples/dotnet/sslputget/README.md +++ b/examples/dotnet/sslputget/README.md @@ -1,4 +1,4 @@ -# SSLPutGet Example +# sslputget example This example illustrates how to use SSL encryption for all traffic between a .NET application and Apache Geode. ## Prerequisites @@ -7,16 +7,43 @@ This example illustrates how to use SSL encryption for all traffic between a .NE * Install [OpenSSL](https://www.openssl.org/) ## Running -* Run the following Powershell script which starts the Geode Locator, defines the keystore and truststore certificates, starts the Geode Server, and creates the region. - ``` - PS> startserver.ps1 - ``` -* Execute `Apache.Geode.Examples.SSLPutGetCs.exe`. - - output: - ``` - Storing id and username in the region - Getting the user info from the region - rtimmons = Robert Timmons - scharles = Sylvia Charles - ``` +1. From a command shell, set the current directory to the `sslputget` directory in your example workspace. + + ```console + $ cd workspace/examples/build/dotnet/sslputget + ``` + +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. + + For Windows cmd: + + ```console + $ powershell.exe -File startserver.ps1 + ``` + + For Windows Powershell: + + ```console + $ startserver.ps1 + ``` + +1. Execute `dotnet-sslputget.exe`, expect the following output: + + Storing id and username in the region + Getting the user info from the region + rtimmons = Robert Timmons + scharles = Sylvia Charles + +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. + + For Windows cmd: + + ```console + $ powershell.exe -File stopserver.ps1 + ``` + + For Windows Powershell: + + ```console + $ stopserver.ps1 + ``` diff --git a/examples/dotnet/transaction/README.md b/examples/dotnet/transaction/README.md index 682f1dc..7bb3ef5 100644 --- a/examples/dotnet/transaction/README.md +++ b/examples/dotnet/transaction/README.md @@ -1,4 +1,4 @@ -# Transaction example +# transaction example This is a very simple example showing how to use TransactionManager. This example shows how to begin a transaction, commit a transaction, and rollback a transaction while showing exception handling. We commit two keys and rollback adding a third key and destroying an @@ -10,50 +10,45 @@ existing key while showing how to handle exceptions. * Apache Geode Native examples, built and installed. ## Running -1. Set the current directory to the `TransactionCs` directory in your example workspace. - - ``` - $ cd workspace/examples/dotnet/TransactionCs - ``` - -1. Run the `startserver.ps1` script to start the Geode server, create a region, and populate the region with sample data. - - ``` - $ sh ./startserver.ps1 - /Users/user/geode/bin/gfsh - - (1) Executing - start locator --name=locator - ... - (2) Executing - start server --name=server - ... - (3) Executing - create region --name=exampleRegion --type=PARTITION - - Member | Status - ------ | ---------------------------------------------- - server | Region "/exampleRegion" created on "server" - ``` - -1. Execute `TransactionCs`: - - ``` - $ build/TransactionCs - Created cache - Created region 'exampleRegion' - Rolled back transaction - retrying(4) - Rolled back transaction - retrying(3) - Rolled back transaction - retrying(2) - Committed transaction - exiting - ``` - -1. Stop the server - - ``` - $ sh ./stopserver.ps1 - /Users/user/geode/bin/gfsh - (1) Executing - connect - ... - (2) Executing - stop server --name=server - ... - (3) Executing - stop locator --name=locator - .... - ``` +1. From a command shell, set the current directory to the `transaction` directory in your example workspace. + + ```console + $ cd workspace/examples/build/dotnet/transaction + ``` + +1. Run the `startserver.ps1` script to start the Geode cluster with authentication and create a region. + + For Windows cmd: + + ```console + $ powershell.exe -File startserver.ps1 + ``` + + For Windows Powershell: + + ```console + $ startserver.ps1 + ``` + +1. Execute `dotnet-transaction.exe`, expect the following output: + + Created cache + Created region 'exampleRegion' + Rolled back transaction - retrying(4) + Rolled back transaction - retrying(3) + Rolled back transaction - retrying(2) + Committed transaction - exiting + +1. Run the `stopserver.ps1` script to gracefully shutdown the Geode cluster. + + For Windows cmd: + + ```console + $ powershell.exe -File stopserver.ps1 + ``` + + For Windows Powershell: + + ```console + $ stopserver.ps1 + ```