Repository: geode-native Updated Branches: refs/heads/develop 273a1f291 -> 00682c330
GEODE-2513 Revise docs section on .NET API per reviews - IGFSerializable becomes IGeodeSerializable - Apache.Geode.Client.dll should be Apache.Geode.dll Project: http://git-wip-us.apache.org/repos/asf/geode-native/repo Commit: http://git-wip-us.apache.org/repos/asf/geode-native/commit/00682c33 Tree: http://git-wip-us.apache.org/repos/asf/geode-native/tree/00682c33 Diff: http://git-wip-us.apache.org/repos/asf/geode-native/diff/00682c33 Branch: refs/heads/develop Commit: 00682c3302d894dcd2dcb527014a5d86dbcd9c75 Parents: 226662f Author: Karen Miller <[email protected]> Authored: Tue Mar 28 16:25:32 2017 -0700 Committer: Karen Miller <[email protected]> Committed: Tue Mar 28 17:31:12 2017 -0700 ---------------------------------------------------------------------- .../source/subnavs/geode-nc-nav.erb | 10 +++++----- .../custom-class-igfserializable.html.md.erb | 10 +++++----- .../how-igfserializable-works.html.md.erb | 2 +- .../implementing-igfserializable.html.md.erb | 16 ++++++++-------- .../dotnet-caching-api/private-assembly.html.md.erb | 10 +++++----- .../registering-the-type.html.md.erb | 2 +- .../serializable-types.html.md.erb | 6 +++--- .../serialize-using-igfserializable.html.md.erb | 10 +++++----- 8 files changed, 33 insertions(+), 33 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode-native/blob/00682c33/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb b/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb index d76a435..6bda757 100644 --- a/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb +++ b/docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb @@ -425,16 +425,16 @@ limitations under the License. </ul> </li> <li class="has_submenu"> - <a href="/docs/guide-native/11/dotnet-caching-api/serialize-using-igfserializable.html">Serialize with the Geode IGFSerializable Interface</a> + <a href="/docs/guide-native/11/dotnet-caching-api/serialize-using-igfserializable.html">Serialize with the IGeodeSerializable Interface</a> <ul> <li> <a href="/docs/guide-native/11/dotnet-caching-api/serializable-types.html">Generic and Custom Serializable Types</a> </li> <li> - <a href="/docs/guide-native/11/dotnet-caching-api/how-igfserializable-works.html">How Serialization Works with IGFSerializable</a> + <a href="/docs/guide-native/11/dotnet-caching-api/how-igfserializable-works.html">How Serialization Works with IGeodeSerializable</a> </li> <li> - <a href="/docs/guide-native/11/dotnet-caching-api/implementing-igfserializable.html">Implement the IGFSerializable Interface</a> + <a href="/docs/guide-native/11/dotnet-caching-api/implementing-igfserializable.html">Implement the IGeodeSerializable Interface</a> </li> <li> <a href="/docs/guide-native/11/dotnet-caching-api/registering-the-type.html">Register the Type</a> @@ -442,7 +442,7 @@ limitations under the License. </ul> </li> <li> - <a href="/docs/guide-native/11/dotnet-caching-api/custom-class-igfserializable.html">Using a Custom Class With IGFSerializable</a> + <a href="/docs/guide-native/11/dotnet-caching-api/custom-class-igfserializable.html">Using a Custom Class With IGeodeSerializable</a> </li> </ul> </li> @@ -459,7 +459,7 @@ limitations under the License. <a href="/docs/guide-native/11/dotnet-caching-api/resolving-the-error.html">Resolving the Error</a> </li> <li> - <a href="/docs/guide-native/11/dotnet-caching-api/private-assembly.html">Using Apache.Geode.Client.dll As a Private Assembly</a> + <a href="/docs/guide-native/11/dotnet-caching-api/private-assembly.html">Using Apache.Geode.dll As a Private Assembly</a> </li> <li> <a href="/docs/guide-native/11/dotnet-caching-api/implementing-shared-assembly.html">Implementing the Shared Assembly</a> http://git-wip-us.apache.org/repos/asf/geode-native/blob/00682c33/docs/geode-native-docs/dotnet-caching-api/custom-class-igfserializable.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/dotnet-caching-api/custom-class-igfserializable.html.md.erb b/docs/geode-native-docs/dotnet-caching-api/custom-class-igfserializable.html.md.erb index d1dcdca..8d6a333 100644 --- a/docs/geode-native-docs/dotnet-caching-api/custom-class-igfserializable.html.md.erb +++ b/docs/geode-native-docs/dotnet-caching-api/custom-class-igfserializable.html.md.erb @@ -1,5 +1,5 @@ --- -title: Using a Custom Class With IGFSerializable +title: Using a Custom Class With IGeodeSerializable --- <!-- @@ -24,7 +24,7 @@ An example shows how to use the `BankAccount` custom key type and the `AccountHi ## Using a BankAccount Object ``` pre -class AccountHistory : IGFSerializable +class AccountHistory : IGeodeSerializable { #region Private members private List<string> m_history; @@ -44,12 +44,12 @@ class AccountHistory : IGFSerializable { m_history.Add(entry); } - public static IGFSerializable CreateInstance() + public static IGeodeSerializable CreateInstance() { return new AccountHistory(); } - #region IGFSerializable Members - public IGFSerializable FromData(DataInput input) + #region IGeodeSerializable Members + public IGeodeSerializable FromData(DataInput input) { int len = input.ReadInt32(); m_history.Clear(); http://git-wip-us.apache.org/repos/asf/geode-native/blob/00682c33/docs/geode-native-docs/dotnet-caching-api/how-igfserializable-works.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/dotnet-caching-api/how-igfserializable-works.html.md.erb b/docs/geode-native-docs/dotnet-caching-api/how-igfserializable-works.html.md.erb index b2fd411..6008497 100644 --- a/docs/geode-native-docs/dotnet-caching-api/how-igfserializable-works.html.md.erb +++ b/docs/geode-native-docs/dotnet-caching-api/how-igfserializable-works.html.md.erb @@ -1,5 +1,5 @@ --- -title: How Serialization Works with IGFSerializable +title: How Serialization Works with IGeodeSerializable --- <!-- http://git-wip-us.apache.org/repos/asf/geode-native/blob/00682c33/docs/geode-native-docs/dotnet-caching-api/implementing-igfserializable.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/dotnet-caching-api/implementing-igfserializable.html.md.erb b/docs/geode-native-docs/dotnet-caching-api/implementing-igfserializable.html.md.erb index d173c29..e9daee6 100644 --- a/docs/geode-native-docs/dotnet-caching-api/implementing-igfserializable.html.md.erb +++ b/docs/geode-native-docs/dotnet-caching-api/implementing-igfserializable.html.md.erb @@ -1,5 +1,5 @@ --- -title: Implement the IGFSerializable Interface +title: Implement the IGeodeSerializable Interface --- <!-- @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -To store your own data types in the cache, you implement the Geode `IGFSerializable` interface. +To store your own data types in the cache, you implement the Geode `IGeodeSerializable` interface. Examples follow the procedure. @@ -45,7 +45,7 @@ Examples follow the procedure. ## Simple BankAccount Class -This example shows a simple class, `BankAccount`, that encapsulates the two `ints` `customerId` and `accountId`: +This example shows a simple class, `BankAccount`, that encapsulates the two `ints`, `customerId` and `accountId`: ``` pre public class BankAccount @@ -76,10 +76,10 @@ public class BankAccount ## Implementing a Serializable Class -To make `BankAccount` serializable, you implement the `IGFSerializable` interface as shown in this example: +To make `BankAccount` serializable, you implement the `IGeodeSerializable` interface as shown in this example: ``` pre -public class BankAccount : IGFSerializable +public class BankAccount : IGeodeSerializable { private int m_customerId; private int m_accountId; @@ -103,17 +103,17 @@ public class BankAccount : IGFSerializable m_accountId = account; } // Our TypeFactoryMethod - public static IGFSerializable CreateInstance() + public static IGeodeSerializable CreateInstance() { return new BankAccount(0, 0); } - #region IGFSerializable Members + #region IGeodeSerializable Members public void ToData(DataOutput output) { output.WriteInt32(m_customerId); output.WriteInt32(m_accountId); } - public IGFSerializable FromData(DataInput input) + public IGeodeSerializable FromData(DataInput input) { m_customerId = input.ReadInt32(); m_accountId = input.ReadInt32(); http://git-wip-us.apache.org/repos/asf/geode-native/blob/00682c33/docs/geode-native-docs/dotnet-caching-api/private-assembly.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/dotnet-caching-api/private-assembly.html.md.erb b/docs/geode-native-docs/dotnet-caching-api/private-assembly.html.md.erb index f303669..62e9824 100644 --- a/docs/geode-native-docs/dotnet-caching-api/private-assembly.html.md.erb +++ b/docs/geode-native-docs/dotnet-caching-api/private-assembly.html.md.erb @@ -1,5 +1,5 @@ --- -title: Using Apache.Geode.Client.dll As a Private Assembly +title: Using Apache.Geode.dll As a Private Assembly --- <!-- @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -To access `Apache.Geode.Client.dll` as a private assembly, you need to specify a `.config` file for your application. +To access `Apache.Geode.dll` as a private assembly, you need to specify a `.config` file for your application. The file needs to be the same name as your application, with a `.config` suffix. For example, the `.config` file for `main.exe` would be `main.exe.config`. The two files must reside in the same directory. @@ -27,7 +27,7 @@ Follow these steps to create a `.config` file: 1. Copy `%GFCPP%/docs/default.exe.config` to the appropriate location. 2. Rename `default.exe.config` to the name of your application. -3. Change the `href` attribute of the `CodeBase` element to point to your `Apache.Geode.Client.dll` file. Any of three path types â http, relative, or absolute â will work. +3. Change the `href` attribute of the `CodeBase` element to point to your `Apache.Geode.dll` file. Any of three path types â http, relative, or absolute â will work. ## A Sample .config File @@ -39,11 +39,11 @@ The following example shows an excerpt of a `.config` file. The `PublicKeyToken` <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1"> <dependentAssembly> - <assemblyIdentity name="Apache.Geode.Client" + <assemblyIdentity name="Apache.Geode" publicKeyToken="126e6338d9f55e0c" culture="neutral" /> <codeBase version="0.0.0.0" - href="../../bin/Apache.Geode.Client.dll"/> + href="../../bin/Apache.Geode.dll"/> </dependentAssembly> </assemblyBinding> </runtime> http://git-wip-us.apache.org/repos/asf/geode-native/blob/00682c33/docs/geode-native-docs/dotnet-caching-api/registering-the-type.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/dotnet-caching-api/registering-the-type.html.md.erb b/docs/geode-native-docs/dotnet-caching-api/registering-the-type.html.md.erb index d05eb3c..018b4d6 100644 --- a/docs/geode-native-docs/dotnet-caching-api/registering-the-type.html.md.erb +++ b/docs/geode-native-docs/dotnet-caching-api/registering-the-type.html.md.erb @@ -41,4 +41,4 @@ If your application uses its own key types that are too complex to easily force See [Serialization in Native Client Mode with a Java Server](../cpp-caching-api/serialization_using_serializable.html#concept_696AB5206C3E45898CC1A24CDD93D003__section_AFB685227E4048BF9FB4FD7C55AED274) for information about implementing key types for a client that is used with a Java cache server. -To extend a type that implements `IPdxSerializable` or `IGFSerializable` for your key, override and implement the `HashCode` and `Equals` methods in the key as needed. +To extend a type that implements `IPdxSerializable` or `IGeodeSerializable` for your key, override and implement the `HashCode` and `Equals` methods in the key as needed. http://git-wip-us.apache.org/repos/asf/geode-native/blob/00682c33/docs/geode-native-docs/dotnet-caching-api/serializable-types.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/dotnet-caching-api/serializable-types.html.md.erb b/docs/geode-native-docs/dotnet-caching-api/serializable-types.html.md.erb index 33f0f1b..70f84d3 100644 --- a/docs/geode-native-docs/dotnet-caching-api/serializable-types.html.md.erb +++ b/docs/geode-native-docs/dotnet-caching-api/serializable-types.html.md.erb @@ -21,16 +21,16 @@ limitations under the License. All built-in generics are automatically registered at initialization. You have a couple of options for complex key types. -If your application uses more complex key types that you want to make more accessible or easier to handle, you can derive a new class from `IGFSerializable`. Another option is for the application to do its own object serialization using `Byte[]` or a custom type. +If your application uses more complex key types that you want to make more accessible or easier to handle, you can derive a new class from `IGeodeSerializable`. Another option is for the application to do its own object serialization using `Byte[]` or a custom type. ## <a id="concept_5D520C87F65B48AFA4240615190B0150__section_DA3BCFFFCB974C65BEE953DF3FAA8442" class="no-quick-link"></a>Blobs -If you have data that is best handled as a blob, such as structs that do not contain pointers, use a `Byte[]` or, if you need something more complex than `Byte[]`, implement a custom type using either `IPdxSerializable` or `IGFSerializable`. +If you have data that is best handled as a blob, such as structs that do not contain pointers, use a `Byte[]` or, if you need something more complex than `Byte[]`, implement a custom type using either `IPdxSerializable` or `IGeodeSerializable`. ## <a id="concept_5D520C87F65B48AFA4240615190B0150__section_D49865F1CF5F467A9FFAD244D990F3F5" class="no-quick-link"></a>Object Graphs If you have a graph of objects in which each node can be serializable, the parent node calls `DataOutput.WriteObject` to delegate the serialization responsibility to its child nodes. Similarly, your application calls `DataInput.ReadObject` to deserialize the object graph. **Note:** -The Geode `IGFSerializable` interface does not support object graphs with multiple references to the same object. If your application uses these types of circular graphs, you must address this design concern explicitly. +The Geode `IGeodeSerializable` interface does not support object graphs with multiple references to the same object. If your application uses these types of circular graphs, you must address this design concern explicitly. http://git-wip-us.apache.org/repos/asf/geode-native/blob/00682c33/docs/geode-native-docs/dotnet-caching-api/serialize-using-igfserializable.html.md.erb ---------------------------------------------------------------------- diff --git a/docs/geode-native-docs/dotnet-caching-api/serialize-using-igfserializable.html.md.erb b/docs/geode-native-docs/dotnet-caching-api/serialize-using-igfserializable.html.md.erb index 41d81dc..7c7bce8 100644 --- a/docs/geode-native-docs/dotnet-caching-api/serialize-using-igfserializable.html.md.erb +++ b/docs/geode-native-docs/dotnet-caching-api/serialize-using-igfserializable.html.md.erb @@ -1,5 +1,5 @@ --- -title: Serialize with the Geode IGFSerializable Interface +title: Serialize with the IGeodeSerializable Interface --- <!-- @@ -19,19 +19,19 @@ See the License for the specific language governing permissions and limitations under the License. --> -The .NET `IGFSerializable` interface provides fast and compact data serialization. +The .NET `IGeodeSerializable` interface provides fast and compact data serialization. - **[Generic and Custom Serializable Types](serializable-types.html)** All built-in generics are automatically registered at initialization. You have a couple of options for complex key types. -- **[How Serialization Works with IGFSerializable](how-igfserializable-works.html)** +- **[How Serialization Works with IGeodeSerializable](how-igfserializable-works.html)** When your application puts an object into the cache for distribution, Geode serializes the data by taking these steps. -- **[Implement the IGFSerializable Interface](implementing-igfserializable.html)** +- **[Implement the IGeodeSerializable Interface](implementing-igfserializable.html)** - To store your own data types in the cache, you implement the Geode `IGFSerializable` interface. + To store your own data types in the cache, you implement the Geode `IGeodeSerializable` interface. - **[Register the Type](registering-the-type.html)**
