You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2022/04/26 01:16:19 UTC
[geode-native] branch support/1.12 updated: GEODE-9921: Rename .NET to .NET Framework (#964)
This is an automated email from the ASF dual-hosted git repository.
dbarnes pushed a commit to branch support/1.12
in repository https://gitbox.apache.org/repos/asf/geode-native.git
The following commit(s) were added to refs/heads/support/1.12 by this push:
new b456d7e20 GEODE-9921: Rename .NET to .NET Framework (#964)
b456d7e20 is described below
commit b456d7e20d2de3269f8502ad7adc6f10734b4e6f
Author: Max Hufnagel <mh...@vmware.com>
AuthorDate: Mon Apr 25 18:16:15 2022 -0700
GEODE-9921: Rename .NET to .NET Framework (#964)
---
docs/geode-native-book-dotnet/config.yml | 6 +-
.../about-client-users-guide.html.md.erb | 9 ++-
.../client-cache-ref.html.md.erb | 4 +-
.../configuring/config-client-cache.html.md.erb | 3 +-
.../configuring/sysprops.html.md.erb | 4 +-
.../continuous-queries.html.md.erb | 4 +-
.../function-execution.html.md.erb | 8 +--
.../app-dev-walkthrough-dotnet.html.md.erb | 12 ++--
.../getting-started-nc-client.html.md.erb | 4 +-
.../getting-started/put-get-example.html.md.erb | 11 ++--
.../config-durable-reconnect.html.md.erb | 2 +-
.../using-queue-conflation.html.md.erb | 2 +-
.../regions/regions.html.md.erb | 2 +-
.../registering-interest-for-entries.html.md.erb | 2 +-
.../remote-queries.html.md.erb | 2 +-
.../security/authentication.html.md.erb | 2 +-
.../serialization/data-serialization.html.md.erb | 14 ++--
.../dotnet-pdx-autoserializer.html.md.erb | 8 +--
.../dotnet-pdx-serialization.html.md.erb | 4 +-
.../pdx-serializable-examples.html.md.erb} | 77 ++++++----------------
.../serialize-using-ipdxserializable.html.md.erb | 2 +-
.../transactions.html.md.erb | 8 +--
22 files changed, 75 insertions(+), 115 deletions(-)
diff --git a/docs/geode-native-book-dotnet/config.yml b/docs/geode-native-book-dotnet/config.yml
index 206fa70c7..b88ba23c5 100644
--- a/docs/geode-native-book-dotnet/config.yml
+++ b/docs/geode-native-book-dotnet/config.yml
@@ -31,11 +31,11 @@ template_variables:
product_version: "1.12"
product_version_nodot: 112
product_language: dotnet
- client_name: Geode Native Client for .NET
+ client_name: Geode Native Client for .NET Framework
min_java_update: 121
support_url: http://geode.apache.org/community
product_url: http://geode.apache.org
- book_title: Apache Geode Native .NET Documentation
+ book_title: Apache Geode Native .NET Framework Documentation
book_header_img: /images/Apache_Geode_logo_symbol_white.png
support_link: <a href="http://geode.apache.org/community" target="_blank">Community</a>
support_call_to_action: <a href="http://geode.apache.org/community" target="_blank">Need Help?</a>
@@ -43,7 +43,7 @@ template_variables:
product_link: <div class="header-item"><a href="http://geode.apache.org">Back to Product Page</a></div>
domain_name: apache.org
book_title_short: Geode Native .NET Docs
- local_header_title: Apache Geode Native .NET
+ local_header_title: Apache Geode Native .NET Framework
local_header_img: /images/Apache_Geode_logo_symbol.png
broken_link_exclusions: iefix|using_custom_classes|arrowhead|cppdocs|dotnetdocs|#
diff --git a/docs/geode-native-docs-dotnet/about-client-users-guide.html.md.erb b/docs/geode-native-docs-dotnet/about-client-users-guide.html.md.erb
index e55f621cd..5759865fc 100644
--- a/docs/geode-native-docs-dotnet/about-client-users-guide.html.md.erb
+++ b/docs/geode-native-docs-dotnet/about-client-users-guide.html.md.erb
@@ -17,16 +17,15 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-This documentation describes the Apache Geode Native Client version <%=vars.product_version%>.
-Source files are available from the [Apache Geode-Native Github repository](https://github.com/apache/geode-native)
+This documentation describes the Apache Geode Native Client version <%=vars.product_version%>.
+Source files are available from the [Apache Geode-Native Github repository](https://github.com/apache/geode-native)
and instructions on how to build this documentation are available in the project README file found at that location.
-The Apache Geode Native Client is a library that provides access for C++ and Microsoft<sup>®</sup> .NET™ clients to an Apache Geode cluster.
+The Apache Geode Native Client is a library that provides access for C++ and Microsoft<sup>®</sup> .NET™ Framework clients to an Apache Geode cluster.
See the API docs for API details:
- [C++ API docs](https://geode.apache.org/releases/latest/cppdocs/index.html)
- - [.NET API docs](https://geode.apache.org/releases/latest/dotnetdocs/index.html)
+ - [.NET Framework API docs](https://geode.apache.org/releases/latest/dotnetdocs/index.html)
See the [_<%=vars.product_name_long%> User Guide_](serverman/about_<%=vars.product_name.downcase%>.html) for information regarding the server.
-
diff --git a/docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb b/docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb
index f11c5ef6a..0b30207e2 100644
--- a/docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb
+++ b/docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb
@@ -40,8 +40,8 @@ When you run your application, the native client runtime library reads and appli
specified in the XML file.
The declarative XML file is used to externalize the configuration of the client cache.
-The contents of the XML file correspond to APIs found in the`apache::geode::client` package for C++ applications,
-and the `Apache::Geode::Client` package for .NET applications.
+The contents of the XML file correspond to APIs found in the `apache::geode::client` package for C++ applications,
+and the `Apache::Geode::Client` package for .NET Framework applications.
Elements are defined in the Client Cache XSD file, named `cpp-cache-1.0.xsd`, which you can find in
your native client distribution in the `xsds` directory, and online at
diff --git a/docs/geode-native-docs-dotnet/configuring/config-client-cache.html.md.erb b/docs/geode-native-docs-dotnet/configuring/config-client-cache.html.md.erb
index c111dfc8c..0e9d2e4a9 100644
--- a/docs/geode-native-docs-dotnet/configuring/config-client-cache.html.md.erb
+++ b/docs/geode-native-docs-dotnet/configuring/config-client-cache.html.md.erb
@@ -32,5 +32,4 @@ Regions are created from `Cache` instances. Regions provide the entry points to
instances of `Region` and `RegionEntry`.
For more information specific to your client programming language, see the
-[.NET Client API](dotnetdocs).
-
+[.NET Framework Client API](dotnetdocs).
diff --git a/docs/geode-native-docs-dotnet/configuring/sysprops.html.md.erb b/docs/geode-native-docs-dotnet/configuring/sysprops.html.md.erb
index f6cbf512b..3155af2b2 100644
--- a/docs/geode-native-docs-dotnet/configuring/sysprops.html.md.erb
+++ b/docs/geode-native-docs-dotnet/configuring/sysprops.html.md.erb
@@ -20,7 +20,7 @@ limitations under the License.
-->
A variety of system properties can be specified when a client connects to a distributed system, either programmatically or in a `geode.properties` file.
-See `Apache::Geode::Client::SystemProperties` in the [.NET API docs](dotnetdocs).
+See `Apache::Geode::Client::SystemProperties` in the [.NET Framework API docs](dotnetdocs).
The following settings can be configured:
@@ -80,7 +80,7 @@ This property is used only if <code class="ph codeph">heap-lru-limit</code> is g
</tr>
<tr class="odd">
<td>enable-chunk-handler-thread</td>
-<td>If the chunk-handler-thread is operative (enable-chunk-handler=true), it processes the response for each application thread.
+<td>If the chunk-handler-thread is operative (enable-chunk-handler=true), it processes the response for each application thread.
When the chunk handler is not operative (enable-chunk-handler=false), each application thread processes its own response.</td>
<td>false</td>
</tr>
diff --git a/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb b/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb
index 45e78270a..00374b1f5 100644
--- a/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb
+++ b/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb
@@ -19,7 +19,7 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-The C++ and .NET clients can initiate queries that run on the <%=vars.product_name%> cache server
+The C++ and .NET Framework clients can initiate queries that run on the <%=vars.product_name%> cache server
and notify the client when the query results have changed. For details on the server-side setup for
continuous queries, see [How Continuous Querying Works](serverman/developing/continuous_querying/how_continuous_querying_works.html)
in the *<%=vars.product_name%> User Guide*.
@@ -70,7 +70,7 @@ The essential steps to create and execute a continuous query are:
1. Iterate through the returned objects.
1. When finished, close down the continuous query.
-### <a id="DotNetCQExample"></a>.NET Continuous Query Example
+### <a id="DotNetCQExample"></a>.NET Framework Continuous Query Example
These C# code excerpts are from the `examples\dotnet\continuousquery` example included in your client
distribution. See the example for full context.
diff --git a/docs/geode-native-docs-dotnet/function-execution.html.md.erb b/docs/geode-native-docs-dotnet/function-execution.html.md.erb
index 126530b12..166c8ab7a 100644
--- a/docs/geode-native-docs-dotnet/function-execution.html.md.erb
+++ b/docs/geode-native-docs-dotnet/function-execution.html.md.erb
@@ -97,13 +97,13 @@ The client:
- invokes the object's execute method to invoke the server-side function
If the client expects results, it must create a result object.
-The .NET example uses a built-in result collector (`IResultCollector.GetResults()`) to retrieve the function results.
+The .NET Framework example uses a built-in result collector (`IResultCollector.GetResults()`) to retrieve the function results.
-### <a id="nc-fe-dotnet_example"></a>.NET Example
-This section contains code snippets showing highlights of the .NET function execution example. They are not intended for cut-and-paste execution.
+### <a id="nc-fe-dotnet_example"></a>.NET Framework Example
+This section contains code snippets showing highlights of the .NET Framework function execution example. They are not intended for cut-and-paste execution.
For the complete source, see the example source directory.
-The .NET example creates a cache, then uses it to create a connection pool.
+The .NET Framework example creates a cache, then uses it to create a connection pool.
```csharp
var cacheFactory = new CacheFactory()
diff --git a/docs/geode-native-docs-dotnet/getting-started/app-dev-walkthrough-dotnet.html.md.erb b/docs/geode-native-docs-dotnet/getting-started/app-dev-walkthrough-dotnet.html.md.erb
index 9896edcc9..8892c8225 100644
--- a/docs/geode-native-docs-dotnet/getting-started/app-dev-walkthrough-dotnet.html.md.erb
+++ b/docs/geode-native-docs-dotnet/getting-started/app-dev-walkthrough-dotnet.html.md.erb
@@ -1,5 +1,5 @@
---
-title: .NET Application Development Walkthrough
+title: .NET Framework Application Development Walkthrough
---
<!--
@@ -19,7 +19,7 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-This section describes how to set up a .NET native client development environment using C# and CMake.
+This section describes how to set up a .NET Framework native client development environment using C# and CMake.
## <a id="prerequisites_dotnet"></a>Prerequisites
This walkthrough assumes that certain components are in place:
@@ -32,9 +32,9 @@ This walkthrough assumes that certain components are in place:
- **Geode**: Install and configure Geode. See the [_Geode User's Guide_](http://geode.apache.org/docs/) for instructions and system requirements.
-- **Visual Studio 2015** or higher and **.NET 4.5.2**.
+- **Visual Studio 2015** or higher and **.NET Framework 4.5.2**.
-To develop a Native Client application using .NET and CMake:
+To develop a Native Client application using .NET Framework and CMake:
- Create a project directory structure
- Populate the project directories with C# source code
@@ -103,7 +103,7 @@ should contain the following CMake instructions:
Combined, the above elements comprise the following CMakeLists.txt:
```
-# CMakeLists.txt for .NET Native Client App
+# CMakeLists.txt for .NET Framework Native Client App
cmake_minimum_required(VERSION 3.10)
project(MyProject LANGUAGES CSharp)
@@ -138,7 +138,7 @@ set_target_properties(MyProject PROPERTIES
$ cmake ..
```
-This creates a Visual Studio solution for your .NET application. For example, `MyProject.sln`.
+This creates a Visual Studio solution for your .NET Framework application. For example, `MyProject.sln`.
## <a id="building_and_running_dotnet"></a>Building and Running the App
diff --git a/docs/geode-native-docs-dotnet/getting-started/getting-started-nc-client.html.md.erb b/docs/geode-native-docs-dotnet/getting-started/getting-started-nc-client.html.md.erb
index f5b019e82..9376de339 100644
--- a/docs/geode-native-docs-dotnet/getting-started/getting-started-nc-client.html.md.erb
+++ b/docs/geode-native-docs-dotnet/getting-started/getting-started-nc-client.html.md.erb
@@ -58,7 +58,7 @@ To connect to a server, your application must follow these steps:
Once the connection pool and the shared region are in place, your client application is ready to share data with the server.
-**Server Connection: .NET Example**
+**Server Connection: .NET Framework Example**
This example of connecting to the server is taken from the .NET `PutGetRemove` example.
@@ -94,7 +94,7 @@ for more details.
### <a id="app_dev_walkthroughs"></a>Application Development Walkthrough
-The [.NET App Development Walkthrough](app-dev-walkthrough-dotnet.html) describes how to set up a native client development environment using CMake.
+The [.NET Framework App Development Walkthrough](app-dev-walkthrough-dotnet.html) describes how to set up a native client development environment using CMake.
## <a id="programming_examples"></a>Programming Examples
diff --git a/docs/geode-native-docs-dotnet/getting-started/put-get-example.html.md.erb b/docs/geode-native-docs-dotnet/getting-started/put-get-example.html.md.erb
index 6aa61bb57..cd7eb4ac3 100644
--- a/docs/geode-native-docs-dotnet/getting-started/put-get-example.html.md.erb
+++ b/docs/geode-native-docs-dotnet/getting-started/put-get-example.html.md.erb
@@ -19,9 +19,9 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-The native client release contains an example written for .NET showing how a client application
-can establish a connection to a cluster and then use that connection to perform basic operations on a remote server.
-The example is located in `../examples/dotnet/putgetremove`.
+The native client release contains an example written for .NET Framework showing how a client
+application can establish a connection to a cluster and then use that connection to perform basic
+operations on a remote server. The example is located in `../examples/dotnet/putgetremove`.
The example performs a sequence of operations, displaying simple log entries as they run.
@@ -39,10 +39,11 @@ The example performs a sequence of operations, displaying simple log entries as
## <a id="put-get-remove-example-code"></a>Put/Get/Remove Example Code
-This section contains code snippets showing highlights of the .NET put/get/remove example. They are not intended for cut-and-paste execution.
+This section contains code snippets showing highlights of the .NET Framework put/get/remove
+example. They are not intended for cut-and-paste execution.
For the complete source, see the example source directory.
-The .NET example creates a cache, then uses it to create a connection pool and a region object (of class `IRegion`).
+The .NET Framework example creates a cache, then uses it to create a connection pool and a region object (of class `IRegion`).
```csharp
var cacheFactory = new CacheFactory()
diff --git a/docs/geode-native-docs-dotnet/preserving-data/config-durable-reconnect.html.md.erb b/docs/geode-native-docs-dotnet/preserving-data/config-durable-reconnect.html.md.erb
index 2f6815eea..d47b0e1a9 100644
--- a/docs/geode-native-docs-dotnet/preserving-data/config-durable-reconnect.html.md.erb
+++ b/docs/geode-native-docs-dotnet/preserving-data/config-durable-reconnect.html.md.erb
@@ -21,7 +21,7 @@ limitations under the License.
You can configure a durable client to obtain an approximate count of pending events upon durable client reconnection. Based on the returned number, you can determine whether to proceed and receive the pending events or to close the cache.
-Use the `getPendingEventCount` (C++ API) and the `PendingEventCount` (.NET API) property to detect whether the previously registered subscription queue is available upon durable client reconnection and the count of pending events in the queue. Based on the returned results, you can then decide whether to receive the remaining events or close the cache if the number is too large.
+Use the `getPendingEventCount` (C++ API) and the `PendingEventCount` (.NET Framework API) property to detect whether the previously registered subscription queue is available upon durable client reconnection and the count of pending events in the queue. Based on the returned results, you can then decide whether to receive the remaining events or close the cache if the number is too large.
For example, consider this code fragment for a client with only the default pool created:
diff --git a/docs/geode-native-docs-dotnet/preserving-data/using-queue-conflation.html.md.erb b/docs/geode-native-docs-dotnet/preserving-data/using-queue-conflation.html.md.erb
index 9f45e52f1..c5ffa8055 100644
--- a/docs/geode-native-docs-dotnet/preserving-data/using-queue-conflation.html.md.erb
+++ b/docs/geode-native-docs-dotnet/preserving-data/using-queue-conflation.html.md.erb
@@ -23,7 +23,7 @@ Conflation of entry update messages can reduce the number of update messages a c
Conflation is enabled for a cache server region, so all clients receiving updates for a particular region benefit from the conflation. To enable conflation, set the cache server’s `enable-subscription-conflation` region attribute to `true`. This region attribute is `false` by default.
-The queue managment code conflates entry updates as part of the enqueue operation. If the previous enqueued item for that key is also an `update` operation, the queue management code removes that previously enqueued update, leaving only the latest update to be sent when event distribution occurs. For high availability, conflation also occurs for any secondary queues.
+The queue management code conflates entry updates as part of the enqueue operation. If the previous enqueued item for that key is also an `update` operation, the queue management code removes that previously enqueued update, leaving only the latest update to be sent when event distribution occurs. For high availability, conflation also occurs for any secondary queues.
Only entry `update` messages in a cache server region with `distributed-no-ack` scope are conflated. Region operations and entry operations other than updates are not conflated.
diff --git a/docs/geode-native-docs-dotnet/regions/regions.html.md.erb b/docs/geode-native-docs-dotnet/regions/regions.html.md.erb
index 5700a16dc..7bffd2c40 100644
--- a/docs/geode-native-docs-dotnet/regions/regions.html.md.erb
+++ b/docs/geode-native-docs-dotnet/regions/regions.html.md.erb
@@ -42,7 +42,7 @@ To create a region:
1. Use cache to instantiate a `RegionFactory` and use it to create a region, specifying any desired attributes
and an association with the connection pool.
-### .NET C# Region Creation Example
+### .NET Framework C# Region Creation Example
This example illustrates how to create a pair of regions using C#:
diff --git a/docs/geode-native-docs-dotnet/regions/registering-interest-for-entries.html.md.erb b/docs/geode-native-docs-dotnet/regions/registering-interest-for-entries.html.md.erb
index d41087496..a6d0dbba4 100644
--- a/docs/geode-native-docs-dotnet/regions/registering-interest-for-entries.html.md.erb
+++ b/docs/geode-native-docs-dotnet/regions/registering-interest-for-entries.html.md.erb
@@ -28,7 +28,7 @@ You can register interest for specific entry keys or for all keys. Regular expre
## <a id="registering-interest-for-entries__section_C9A3D7F193B24ACD83B2D67813E596A0" class="no-quick-link"></a>Client API for Registering Interest
-You register client interest through the .NET API. The .NET API provides the `RegisterKeys`, `RegisterAllKeys`, and `RegisterRegex` methods, with corresponding unregistration accomplished using the `UnregisterKeys`, `UnregisterAllKeys`, and `UnregisterRegex` methods.
+You register client interest through the .NET Framework API. The .NET Framework API provides the `RegisterKeys`, `RegisterAllKeys`, and `RegisterRegex` methods, with corresponding unregistration accomplished using the `UnregisterKeys`, `UnregisterAllKeys`, and `UnregisterRegex` methods.
The `RegisterKeys`, `RegisterRegex` and `RegisterAllKeys` methods have the option to populate the cache with the registration results from the server. The `RegisterRegex` and `RegisterAllKeys` methods can also optionally return the current list of keys registered on the server.
diff --git a/docs/geode-native-docs-dotnet/remote-queries.html.md.erb b/docs/geode-native-docs-dotnet/remote-queries.html.md.erb
index 15e4f6b55..ecb6dedbf 100644
--- a/docs/geode-native-docs-dotnet/remote-queries.html.md.erb
+++ b/docs/geode-native-docs-dotnet/remote-queries.html.md.erb
@@ -76,7 +76,7 @@ The essential steps to create and execute a query are:
remotely evaluates the query string and returns the results to the client.
1. Iterate through the returned objects.
-### <a id="DotNetQueryExample"></a>.NET Query Example
+### <a id="DotNetQueryExample"></a>.NET Framework Query Example
These C# code excerpts are from the `examples\dotnet\remotequery` example included in your client
distribution. See the example for full context.
diff --git a/docs/geode-native-docs-dotnet/security/authentication.html.md.erb b/docs/geode-native-docs-dotnet/security/authentication.html.md.erb
index b2ed3534d..eaf2ed076 100644
--- a/docs/geode-native-docs-dotnet/security/authentication.html.md.erb
+++ b/docs/geode-native-docs-dotnet/security/authentication.html.md.erb
@@ -25,7 +25,7 @@ For details on the server's role in authentication and what it expects from the
In your application, authentication credentials must be set when creating the cache. In practice,
this means setting the authentication credentials when you create the CacheFactory.
-### .NET Authentication Example
+### .NET Framework Authentication Example
The following excerpt is taken from the .NET example provided with your Native Client distribution in the `../examples/dotnet/authinitialize` directory.
diff --git a/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb b/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb
index 9e8c5ad15..1079f0313 100644
--- a/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb
+++ b/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb
@@ -42,7 +42,7 @@ Pdx serialization provides custom serialization to an individual class. Fields w
Setting up a custom class for PdxSerializable treatment requires some preparatory steps:
-- The custom class must inherit from the .NET IPdxSerializable interface.
+- The custom class must inherit from the .NET Framework IPdxSerializable interface.
- You must provide serialization instructions for objects of the custom class. Specifically:
@@ -57,7 +57,7 @@ Setting up a custom class for PdxSerializable treatment requires some preparator
## PdxSerializable Examples
The native client release contains examples showing how a client application
-can register for serialization of custom objects using the .NET IPdxSerializable interface.
+can register for serialization of custom objects using the .NET Framework IPdxSerializable interface.
The examples are located in `examples\dotnet\pdxserializable`.
@@ -84,12 +84,12 @@ The example performs a sequence of operations, displaying simple log entries as
<a id="pdsxbl_dotnet_example"></a>
-### .NET Example
+### .NET Framework Example
-This section contains code snippets showing highlights of the .NET PdxSerializable example. They are not intended for cut-and-paste execution.
+This section contains code snippets showing highlights of the .NET Framework PdxSerializable example. They are not intended for cut-and-paste execution.
For the complete source, see the example source directory.
-The .NET example defines a PdxSerializable class called `Order` that inherits from the `IPdxSerializable` interface.
+The .NET Framework example defines a PdxSerializable class called `Order` that inherits from the `IPdxSerializable` interface.
An `Order` object contains three fields:
- an integer `order_id`
@@ -138,7 +138,7 @@ From Order.cs:
}
```
-The .NET example mainline creates a cache, then uses it to register the PdxSerializable class that was created in Orders.cs:
+The .NET Framework example mainline creates a cache, then uses it to register the PdxSerializable class that was created in Orders.cs:
```csharp
var cacheFactory = new CacheFactory()
@@ -181,5 +181,3 @@ Finally, the application closes the cache:
```csharp
cache.Close();
```
-
-
diff --git a/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/dotnet-pdx-autoserializer.html.md.erb b/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/dotnet-pdx-autoserializer.html.md.erb
index b86d5c173..6db92f95c 100644
--- a/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/dotnet-pdx-autoserializer.html.md.erb
+++ b/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/dotnet-pdx-autoserializer.html.md.erb
@@ -47,9 +47,9 @@ When you register the reflection-based serializer, <%=vars.product_name%> uses i
See [Extending the Autoserializer](extending-pdx-autoserializer.html#concept_87701FF3FAE74F3193BE3FB349CE0086) for sample usage.
- 2. If you are writing a Java application, you can use the `IPdxType` Mapper to map Java types to .NET types. Note that you only need to use the `IPdxTypeMapper` if you are writing Java applications.
+ 2. If you are writing a Java application, you can use the `IPdxType` Mapper to map Java types to .NET Framework types. Note that you only need to use the `IPdxTypeMapper` if you are writing Java applications.
- See [Map .NET Domain Type Names to PDX Type Names with IPdxTypeMapper](mapping-dotnet-domain-type-names.html#concept_63F4164F1AE242A9BA309738F484182D) for sample usage.
+ See [Map .NET Framework Domain Type Names to PDX Type Names with IPdxTypeMapper](mapping-dotnet-domain-type-names.html#concept_63F4164F1AE242A9BA309738F484182D) for sample usage.
3. To specify an identifier field in your domain object, add the attribute `PdxIdentityField` to the field.
@@ -59,7 +59,7 @@ When you register the reflection-based serializer, <%=vars.product_name%> uses i
[PdxIdentityField] private int id;
```
- 4. To exclude a field from serialization, add the .NET attribute `NonSerialized` to the field.
+ 4. To exclude a field from serialization, add the .NET Framework attribute `NonSerialized` to the field.
For example:
@@ -67,4 +67,4 @@ When you register the reflection-based serializer, <%=vars.product_name%> uses i
[NonSerialized] private int myLocalData;
```
-For each domain class <%=vars.product_name%> serializes using the autoserializer, all fields are considered for serialization except those defined as `static`, `literal` or `readonly` and those you explicitly exclude using the .NET `NonSerialized` attribute.
+For each domain class <%=vars.product_name%> serializes using the autoserializer, all fields are considered for serialization except those defined as `static`, `literal` or `readonly` and those you explicitly exclude using the .NET Framework `NonSerialized` attribute.
diff --git a/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/dotnet-pdx-serialization.html.md.erb b/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/dotnet-pdx-serialization.html.md.erb
index 2818d864e..c22c03856 100644
--- a/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/dotnet-pdx-serialization.html.md.erb
+++ b/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/dotnet-pdx-serialization.html.md.erb
@@ -21,7 +21,7 @@ limitations under the License.
<%=vars.product_name%>'s Portable Data eXchange (PDX) is a cross-language data format that can reduce the cost of distributing and serializing your objects. PDX stores data in named fields that you can access individually, to avoid the cost of deserializing the entire data object. PDX also allows you to mix versions of objects where you have added or removed fields.
-You have two options for <%=vars.product_name%> PDX serialization when using the .NET caching API. You can program your domain objects using the `IPdxSerializable` interface, or you can use <%=vars.product_name%>’s reflection-based autoserializer.
+You have two options for <%=vars.product_name%> PDX serialization when using the .NET Framework caching API. You can program your domain objects using the `IPdxSerializable` interface, or you can use <%=vars.product_name%>’s reflection-based autoserializer.
- [Geode PDX Serialization Features](dotnet-pdx-serialization-features.html)
- [Serialize Using the Geode PDX Autoserializer](dotnet-pdx-autoserializer.html)
@@ -30,6 +30,6 @@ You have two options for <%=vars.product_name%> PDX serialization when using the
- [Serialize Using the IPdxSerializable Interface](serialize-using-ipdxserializable.html)
- [Program Your Application to Use IPdxInstance](programming-ipdxinstance.html)
- [Use the IPdxInstanceFactory to Create IPdxInstances](using-ipdxinstancefactory.html)
-- [Map .NET Domain Type Names to PDX Type Names with IPdxTypeMapper](mapping-dotnet-domain-type-names.html)
+- [Map .NET Framework Domain Type Names to PDX Type Names with IPdxTypeMapper](mapping-dotnet-domain-type-names.html)
- [Data Serialization Options](dotnet-data-serialization-options.html)
- [Serialize with PDX Serialization](dotnet-pdx-serialization.html)
diff --git a/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb b/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/pdx-serializable-examples.html.md.erb
similarity index 55%
copy from docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb
copy to docs/geode-native-docs-dotnet/serialization/dotnet-serialization/pdx-serializable-examples.html.md.erb
index 9e8c5ad15..bb180bab9 100644
--- a/docs/geode-native-docs-dotnet/serialization/data-serialization.html.md.erb
+++ b/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/pdx-serializable-examples.html.md.erb
@@ -1,5 +1,5 @@
---
-title: Serializing Data
+title: IPdxSerializable Example
---
<!--
@@ -19,57 +19,21 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-Data in your client application's <%=vars.product_name%> cache must be serializable to be shared with <%=vars.product_name%> servers and other
-<%=vars.product_name%> clients.
-<%=vars.product_name%> provides multiple data serialization options for storage and transmittal
-between processes, of which **<%=vars.product_name%> Portable Data eXchange (PDX) serialization** offers
-the best combination of versatility and ease-of-use for most applications.
+The native client release contain an example showing how a client application can register for
+serialization of domain objects using the .NET Framework IPdxSerializable interface.
-To learn more about other serialization options, see the [Data Serialization section in the _<%=vars.product_name_long%> User Guide_](serverman/developing/data_serialization/chapter_overview.html).
+The example is located in `examples\dotnet\pdxserializable`.
-<a id="implementing_pdxsbl_class"></a>
-## Implementing a PdxSerializable Custom Class
-
-Pdx serialization provides custom serialization to an individual class. Fields within an object can be serialized separately from the rest of the class.
-
-The type of serialization and its implementation can be specified entirely in the client
-application, with no need to create corresponding code on the <%=product_name%> server.
-
-<a id="setup_pdxsbl_class"></a>
-### Setup
-
-Pdx serialization provides custom serialization to an individual class. Fields within an object can be serialized separately from the rest of the class.
-
-Setting up a custom class for PdxSerializable treatment requires some preparatory steps:
-
-- The custom class must inherit from the .NET IPdxSerializable interface.
-
-- You must provide serialization instructions for objects of the custom class. Specifically:
-
- - You must implement the `ToData()` and `FromData()` methods.
- - You must provide a "factory method" that returns an instance of the custom object.
-
-- Your application must register your custom class with the cache, which takes care of informing the server of your
- serialization scheme. With registration, you provide the name of the "factory method" you created for instantiating
- objects of the custom class.
-
-<a id="pdxsbl_examples"></a>
-## PdxSerializable Examples
-
-The native client release contains examples showing how a client application
-can register for serialization of custom objects using the .NET IPdxSerializable interface.
-
-The examples are located in `examples\dotnet\pdxserializable`.
-
-The examples define the serializable class, `Orders`, including its serialization and deserialization methods and its factory method.
-Once these pieces are in place, execution is simple: the main routine of the example registers the serializable class then performs some put and get operations.
+The example defines the serializable class, `Orders`, including its serialization and deserialization methods and its factory method.
+Once these pieces are in place, execution is simple: the main routine of the example registers the serializable class then performs some Put and Get operations.
<a id="pdxsbl_execution"></a>
-### Execution
+## Execution
The example performs a sequence of operations, displaying simple log entries as they run.
-- To run an example, follow the instructions in the README.md file in the example directory.
+- To run the example, follow the instructions in the README.md file in the example directory.
+
- Review the source code in the example directory to see exactly how it operates.
- Begin by running a script that sets up the server-side environment by invoking `gfsh` commands to create a region, a locator, and a server.
@@ -84,12 +48,12 @@ The example performs a sequence of operations, displaying simple log entries as
<a id="pdsxbl_dotnet_example"></a>
-### .NET Example
+## .NET Framework Example
-This section contains code snippets showing highlights of the .NET PdxSerializable example. They are not intended for cut-and-paste execution.
+This section contains code snippets showing highlights of the .NET Framework PdxSerializable example. They are not intended for cut-and-paste execution.
For the complete source, see the example source directory.
-The .NET example defines a PdxSerializable class called `Order` that inherits from the `IPdxSerializable` interface.
+The .NET Framework example defines a PdxSerializable class called `Order` that inherits from the `IPdxSerializable` interface.
An `Order` object contains three fields:
- an integer `order_id`
@@ -138,12 +102,12 @@ From Order.cs:
}
```
-The .NET example mainline creates a cache, then uses it to register the PdxSerializable class that was created in Orders.cs:
+The .NET Framework example mainline creates a cache, then uses it to register the PdxSerializable class that was created in Orders.cs:
```csharp
- var cacheFactory = new CacheFactory()
- .Set("log-level", "none");
- var cache = cacheFactory.Create();
+var cache = new CacheFactory()
+ .Set("log-level", "none")
+ .Create();
cache.TypeRegistry.RegisterPdxType(Order.CreateDeserializable);
```
@@ -151,9 +115,10 @@ The .NET example mainline creates a cache, then uses it to register the PdxSeria
The client creates a connection pool and a region named "example_orderobject":
```csharp
- var poolFactory = cache.GetPoolFactory()
- .AddLocator("localhost", 10334);
- poolFactory.Create("pool");
+cache.GetPoolManager()
+ .CreateFactory()
+ .AddLocator("localhost", 10334)
+ .Create("pool");
var regionFactory = cache.CreateRegionFactory(RegionShortcut.PROXY)
.SetPoolName("pool");
@@ -181,5 +146,3 @@ Finally, the application closes the cache:
```csharp
cache.Close();
```
-
-
diff --git a/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/serialize-using-ipdxserializable.html.md.erb b/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/serialize-using-ipdxserializable.html.md.erb
index b4f1b6942..97742bda4 100644
--- a/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/serialize-using-ipdxserializable.html.md.erb
+++ b/docs/geode-native-docs-dotnet/serialization/dotnet-serialization/serialize-using-ipdxserializable.html.md.erb
@@ -36,7 +36,7 @@ Use this procedure to program your domain object for PDX serialization using the
If you also use PDX serialization in Java for the object, serialize the object in the same way for each language. Serialize the same fields in the same order and mark the same identify fields.
3. Program the `IPdxSerializable ToData` function to serialize your object as required by your application.
- 1. Write your domain class's standard .NET data fields using the `IPdxWriter` write methods. <%=vars.product_name%> automatically provides `IPdxWriter` to the `ToData` function for `IPdxSerializable` objects.
+ 1. Write your domain class's standard .NET Framework data fields using the `IPdxWriter` write methods. <%=vars.product_name%> automatically provides `IPdxWriter` to the `ToData` function for `IPdxSerializable` objects.
2. Call the `ToData MarkIdentifyField` function for each field <%=vars.product_name%> should use to identify your object. This is used to compare objects for operations like `DISTINCT` queries. The `MarkIdentifyField` call must come after the associated field write methods.
Example:
diff --git a/docs/geode-native-docs-dotnet/transactions.html.md.erb b/docs/geode-native-docs-dotnet/transactions.html.md.erb
index 25aea849d..2d580d12e 100644
--- a/docs/geode-native-docs-dotnet/transactions.html.md.erb
+++ b/docs/geode-native-docs-dotnet/transactions.html.md.erb
@@ -29,7 +29,7 @@ For complete information about how transactions are conducted on the <%=vars.pro
The API for distributed transactions has the familiar relational database methods, `Begin`,
`Commit`, and `Rollback`. There are also APIs available to suspend and resume transactions.
-The .NET classes for executing transactions are:
+The .NET Framework classes for executing transactions are:
- `Apache.Geode.Client.CacheTransactionManager`
- `Apache.Geode.Client.TransactionId`
@@ -80,12 +80,12 @@ treated as unsuccessful. The transaction is retried until it succeeds.
- In case the transaction repeatedly fails, the retry loop uses a counter to set a limit of 5 retries.
-### <a id="dotnet-example"></a>.NET Example
+### <a id="dotnet-example"></a>.NET Framework Example
-This section contains code snippets showing highlights of the .NET transaction example. They are not intended for cut-and-paste execution.
+This section contains code snippets showing highlights of the .NET Framework transaction example. They are not intended for cut-and-paste execution.
For the complete source, see the example source directory.
-The .NET example creates a cache, then uses it to create a connection pool.
+The .NET Framework example creates a cache, then uses it to create a connection pool.
```csharp
var cache = new CacheFactory()