Skip to content

Commit

Permalink
GEODE-9921: Rename .NET to .NET Framework (#964)
Browse files Browse the repository at this point in the history
  • Loading branch information
animatedmax authored Apr 26, 2022
1 parent 4b0d9a2 commit b456d7e
Show file tree
Hide file tree
Showing 22 changed files with 203 additions and 58 deletions.
6 changes: 3 additions & 3 deletions docs/geode-native-book-dotnet/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,19 @@ 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>
changelog_href: https://cwiki.apache.org/confluence/display/GEODE/Release+Notes
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|#
Original file line number Diff line number Diff line change
Expand Up @@ -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.

4 changes: 2 additions & 2 deletions docs/geode-native-docs-dotnet/client-cache-ref.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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>
Expand Down
4 changes: 2 additions & 2 deletions docs/geode-native-docs-dotnet/continuous-queries.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -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*.
Expand Down Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/geode-native-docs-dotnet/function-execution.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: .NET Application Development Walkthrough
title: .NET Framework Application Development Walkthrough
---

<!--
Expand All @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/geode-native-docs-dotnet/regions/regions.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -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#:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/geode-native-docs-dotnet/remote-queries.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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`.

Expand All @@ -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`
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -181,5 +181,3 @@ Finally, the application closes the cache:
```csharp
cache.Close();
```


Loading

0 comments on commit b456d7e

Please sign in to comment.