docs/geode-native/dotnet/113/serialization/dotnet-serialization/pdx-serializable-examples.html - geode-site - Git at Google

 <!doctype html>
 <html>
 <head>
   <meta charset="utf-8">
   <!-- Always force latest IE rendering engine or request Chrome Frame -->
   <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">


   <link href='https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,300italic,400italic,400,600' rel='stylesheet' type='text/css'>
   <!-- Use title if it's in the page YAML frontmatter -->
   <title>
       IPdxSerializable Example |
     Geode Native .NET Docs
   </title>
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <link href="/stylesheets/all.css" rel="stylesheet" media="screen, print" />
   <link href="/stylesheets/print.css" rel="stylesheet" media="print" />
   <link href='/images/favicon.ico' rel='shortcut icon'>

   <script src="/javascripts/all.js"></script>

 </head>

 <body class="docs docs_geode-native docs_geode-native_dotnet docs_geode-native_dotnet_113 docs_geode-native_dotnet_113_serialization docs_geode-native_dotnet_113_serialization_dotnet-serialization docs_geode-native_dotnet_113_serialization_dotnet-serialization_pdx-serializable-examples has-subnav">

 <div class="viewport">
   <div class='wrap'>
     <script type="text/javascript">
       document.domain = "apache.org";
     </script>

     <!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
 <header class="header header-layout">
   <h1 class="logo">
     <a href="/">
         <img src="/images/Apache_Geode_logo_symbol_white.png" style="width:30px;">
       Apache Geode Native .NET Documentation
     </a>
   </h1>
   <div class="header-links js-bar-links">
     <div class="btn-menu" data-behavior="MenuMobile"></div>
     <div class="header-item"><a href="http://geode.apache.org">Back to Product Page</a></div>
     <div class="header-item">
       <a href="http://geode.apache.org/community" target="_blank">Community</a>
     </div>
   </div>
 </header>


     <div class="container">

       <!--googleoff: index-->
       <!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
 <div id="sub-nav" class="js-sidenav nav-container" role="navigation">
 <a class="sidenav-title" data-behavior="SubMenuMobile">Doc Index</a>
   <div class="nav-content">
   <ul>
     <li>
       <a href="/docs/geode-native/dotnet/113/about-client-users-guide.html">Apache Geode Native Documentation</a>
     </li>
     <li class="has_submenu">
       <a href="/docs/geode-native/dotnet/113/getting-started/getting-started-nc-client.html">Getting Started with the Native Library</a>
       <ul>
         <li>
           <a href="/docs/geode-native/dotnet/113/getting-started/getting-started-nc-client.html#set_up_dev_environment">Set Up Your Development Environment</a>
         </li>
         <li>
           <a href="/docs/geode-native/dotnet/113/getting-started/getting-started-nc-client.html#establish_cluster_access">Establish Access to a Geode Cluster</a>
         </li>
         <li>
           <a href="/docs/geode-native/dotnet/113/getting-started/getting-started-nc-client.html#app_dev_walkthroughs">Application Development Walkthroughs</a>
         </li>
         <li>
           <a href="/docs/geode-native/dotnet/113/getting-started/getting-started-nc-client.html#programming_examples">Programming Examples</a>
         </li>
         <li>
           <a href="/docs/geode-native/dotnet/113/getting-started/put-get-example.html">Put/Get/Remove Examples</a>
         </li>
       </ul>
     </li>
     <li class="has_submenu">
       <a href="/docs/geode-native/dotnet/113/configuring/configuration.html">Configuring a Client Application</a>
       <ul>
         <li>
           <a href="/docs/geode-native/dotnet/113/configuring/system-level-configuration.html">System Level Configuration</a>
         </li>
       </ul>
     </li>

     <li>
       <a href="/docs/geode-native/dotnet/113/configuring/config-client-cache.html">Configuring the Client Cache</a>
     </li>
     <li class="has_submenu">
       <a href="/docs/geode-native/dotnet/113/regions/regions.html">Configuring Regions</a>
       <ul>
         <li>
         <a href="/docs/geode-native/dotnet/113/regions/registering-interest-for-entries.html">Registering Interest for Entries</a>
         </li>
         <li>
         <a href="/docs/geode-native/dotnet/113/regions/region-attributes.html">Region Attributes</a>
         </li>
       </ul>
     </li>

     <li class="has_submenu">
         <a href="/docs/geode-native/dotnet/113/connection-pools/configuring-pools.html">Configuring Pools</a>
         <ul>
             <li>
                 <a href="/docs/geode-native/dotnet/113/connection-pools/client-pool-api.html">Native Client Pool API</a>
             </li>
             <li>
                 <a href="/docs/geode-native/dotnet/113/connection-pools/configuring-pools-attributes-example.html">Pool Configuration Example and Settings</a>
             </li>
             <li>
                 <a href="/docs/geode-native/dotnet/113/connection-pools/subscription-properties.html">Subscription Properties</a>
             </li>
         </ul>
     </li>

     <li class="has_submenu">
       <a href="/docs/geode-native/dotnet/113/serialization/data-serialization.html">Serializing Data</a>
       <ul>
         <li class="has_submenu">
           <a href="/docs/geode-native/dotnet/113/serialization/dotnet-serialization/dotnet-pdx-serialization.html">Geode PDX Serialization</a>
           <ul>
             <li>
               <a href="/docs/geode-native/dotnet/113/serialization/dotnet-serialization/dotnet-pdx-autoserializer.html">Using the Geode PDX Autoserializer</a>
             </li>
             <li>
               <a href="/docs/geode-native/dotnet/113/serialization/dotnet-serialization/serialize-using-ipdxserializable.html">Using the IPdxSerializable Interface</a>
             </li>
             <li>
               <a href="/docs/geode-native/dotnet/113/serialization/dotnet-serialization/pdx-serializable-examples.html">IPdxSerializable Example</a>
             </li>
           </ul>
         </li>
       </ul>
     </li>

     <li>
       <a href="/docs/geode-native/dotnet/113/remote-queries.html">Remote Queries</a>
     </li>

     <li>
       <a href="/docs/geode-native/dotnet/113/continuous-queries.html">Continuous Queries</a>
     </li>

     <li class="has_submenu">
       <a href="/docs/geode-native/dotnet/113/security/security.html">Security: Authentication and Encryption</a>
       <ul>
         <li>
         <a href="/docs/geode-native/dotnet/113/security/authentication.html">Authentication</a>
         </li>
         <li>
         <a href="/docs/geode-native/dotnet/113/security/sslclientserver.html">TLS/SSL Client-Server Communication Encryption</a>
         </li>
       </ul>
     </li>

     <li>
       <a href="/docs/geode-native/dotnet/113/function-execution.html">Function Execution</a>
     </li>

     <li>
       <a href="/docs/geode-native/dotnet/113/transactions.html">Transactions</a>
     </li>
     <li>
       <a href="/docs/geode-native/dotnet/113/configuring/sysprops.html">System Properties</a>
     </li>
     <li>
       <a href="/docs/geode-native/dotnet/113/client-cache-ref.html">Client Cache XML Reference</a>
     </li>
   </ul>
   </div>
 </div>

       <!--googleon: index-->

       <main class="content content-layout" id="js-content" role="main">
         <a id="top"></a>
         <!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
 <span style="font-weight:200;font-size:31px;" style="float:left;">
     <img src="/images/Apache_Geode_logo_symbol.png" style="height:26px;">
   Apache Geode Native .NET
 </span>
   <span class="local-header version-info" style="float:right;">
     <a href="https://cwiki.apache.org/confluence/display/GEODE/Release+Notes">CHANGELOG</a>
   </span>

         <!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
   <h1 class="title-container" >
     IPdxSerializable Example
   </h1>

           <div id="js-quick-links" >

           </div>
         <div class="to-top" id="js-to-top">
           <a href="#top" title="back to top"></a>
         </div>
         <!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 -->

 <p>The native client release contain an example showing how a client application
 can register for serialization of domain objects using the .NET IPdxSerializable interface.</p>

 <p>The example is located in <code>examples\dotnet\pdxserializable</code>.</p>

 <p>The example defines the serializable class, <code>Orders</code>, 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.</p>

 <p><a id="pdxsbl_execution"></a></p>

 <h2 id="execution">Execution</h2>

 <p>The example performs a sequence of operations, displaying simple log entries as they run.</p>

 <ul>
 <li><p>To run the example, follow the instructions in the README.md file in the example directory.</p></li>
 <li><p>Review the source code in the example directory to see exactly how it operates.</p></li>
 <li><p>Begin by running a script that sets up the server-side environment by invoking <code>gfsh</code> commands to create a region, a locator, and a server.</p></li>
 <li><p>Run the example client application, which performs the following steps:</p>

 <ul>
 <li>Connects to the server</li>
 <li>Registers the PdxSerializable class</li>
 <li>Creates orders</li>
 <li>Stores orders</li>
 <li>Retrieves orders</li>
 </ul></li>
 </ul>

 <p><a id="pdsxbl_dotnet_example"></a></p>

 <h2 id=".net-example">.NET Example</h2>

 <p>This section contains code snippets showing highlights of the .NET PdxSerializable example. They are not intended for cut-and-paste execution.
 For the complete source, see the example source directory.</p>

 <p>The .NET example defines a PdxSerializable class called <code>Order</code> that inherits from the <code>IPdxSerializable</code> interface.
 An <code>Order</code> object contains three fields:</p>

 <ul>
 <li>an integer <code>order_id</code></li>
 <li>a string <code>name</code></li>
 <li>a short-int <code>quantity</code></li>
 </ul>

 <p>From Order.cs:</p>
 <pre class="highlight csharp"><code>  <span class="k">public</span> <span class="k">class</span> <span class="nc">Order</span> <span class="p">:</span> <span class="n">IPdxSerializable</span>
   <span class="p">{</span>
     <span class="p">...</span>
     <span class="k">public</span> <span class="kt">long</span> <span class="n">OrderId</span> <span class="p">{</span> <span class="k">get</span><span class="p">;</span> <span class="k">set</span><span class="p">;</span> <span class="p">}</span>
     <span class="k">public</span> <span class="kt">string</span> <span class="n">Name</span> <span class="p">{</span> <span class="k">get</span><span class="p">;</span> <span class="k">set</span><span class="p">;</span> <span class="p">}</span>
     <span class="k">public</span> <span class="kt">short</span> <span class="n">Quantity</span> <span class="p">{</span> <span class="k">get</span><span class="p">;</span> <span class="k">set</span><span class="p">;</span> <span class="p">}</span>
 </code></pre>

 <p>Using the <code>IPdxSerializable</code> read and write methods, the <code>Order</code> class defines <code>ToData()</code> and <code>FromData()</code>
 methods that perform the serialization and deserialization operations, respectively, and the <code>CreateDeserializable()</code> factory method:</p>

 <p>From Order.cs:</p>
 <pre class="highlight csharp"><code>    <span class="k">public</span> <span class="k">void</span> <span class="nf">ToData</span><span class="p">(</span><span class="n">IPdxWriter</span> <span class="n">output</span><span class="p">)</span>
     <span class="p">{</span>
       <span class="n">output</span><span class="p">.</span><span class="nf">WriteLong</span><span class="p">(</span><span class="n">ORDER_ID_KEY_</span><span class="p">,</span> <span class="n">OrderId</span><span class="p">);</span>
       <span class="n">output</span><span class="p">.</span><span class="nf">MarkIdentityField</span><span class="p">(</span><span class="n">ORDER_ID_KEY_</span><span class="p">);</span>

       <span class="n">output</span><span class="p">.</span><span class="nf">WriteString</span><span class="p">(</span><span class="n">NAME_KEY_</span><span class="p">,</span> <span class="n">Name</span><span class="p">);</span>
       <span class="n">output</span><span class="p">.</span><span class="nf">MarkIdentityField</span><span class="p">(</span><span class="n">NAME_KEY_</span><span class="p">);</span>

       <span class="n">output</span><span class="p">.</span><span class="nf">WriteInt</span><span class="p">(</span><span class="n">QUANTITY_KEY_</span><span class="p">,</span> <span class="n">Quantity</span><span class="p">);</span>
       <span class="n">output</span><span class="p">.</span><span class="nf">MarkIdentityField</span><span class="p">(</span><span class="n">QUANTITY_KEY_</span><span class="p">);</span>
     <span class="p">}</span>

     <span class="k">public</span> <span class="k">void</span> <span class="nf">FromData</span><span class="p">(</span><span class="n">IPdxReader</span> <span class="n">input</span><span class="p">)</span>
     <span class="p">{</span>
       <span class="n">OrderId</span> <span class="p">=</span> <span class="n">input</span><span class="p">.</span><span class="nf">ReadLong</span><span class="p">(</span><span class="n">ORDER_ID_KEY_</span><span class="p">);</span>
       <span class="n">Name</span> <span class="p">=</span> <span class="n">input</span><span class="p">.</span><span class="nf">ReadString</span><span class="p">(</span><span class="n">NAME_KEY_</span><span class="p">);</span>
       <span class="n">Quantity</span> <span class="p">=</span> <span class="p">(</span><span class="kt">short</span><span class="p">)</span><span class="n">input</span><span class="p">.</span><span class="nf">ReadInt</span><span class="p">(</span><span class="n">QUANTITY_KEY_</span><span class="p">);</span>
     <span class="p">}</span>

     <span class="k">public</span> <span class="k">static</span> <span class="n">IPdxSerializable</span> <span class="nf">CreateDeserializable</span><span class="p">()</span>
     <span class="p">{</span>
       <span class="k">return</span> <span class="k">new</span> <span class="nf">Order</span><span class="p">();</span>
     <span class="p">}</span>
 </code></pre>

 <p>The .NET example mainline creates a cache, then uses it to register the PdxSerializable class that was created in Orders.cs:</p>
 <pre class="highlight csharp"><code><span class="kt">var</span> <span class="n">cache</span> <span class="p">=</span> <span class="k">new</span> <span class="nf">CacheFactory</span><span class="p">()</span>
     <span class="p">.</span><span class="nf">Set</span><span class="p">(</span><span class="s">"log-level"</span><span class="p">,</span> <span class="s">"none"</span><span class="p">)</span>
     <span class="p">.</span><span class="nf">Create</span><span class="p">();</span>

    <span class="n">cache</span><span class="p">.</span><span class="n">TypeRegistry</span><span class="p">.</span><span class="nf">RegisterPdxType</span><span class="p">(</span><span class="n">Order</span><span class="p">.</span><span class="n">CreateDeserializable</span><span class="p">);</span>
 </code></pre>

 <p>The client creates a connection pool and a region named &ldquo;example_orderobject&rdquo;:</p>
 <pre class="highlight csharp"><code><span class="n">cache</span><span class="p">.</span><span class="nf">GetPoolManager</span><span class="p">()</span>
     <span class="p">.</span><span class="nf">CreateFactory</span><span class="p">()</span>
     <span class="p">.</span><span class="nf">AddLocator</span><span class="p">(</span><span class="s">"localhost"</span><span class="p">,</span> <span class="m">10334</span><span class="p">)</span>
     <span class="p">.</span><span class="nf">Create</span><span class="p">(</span><span class="s">"pool"</span><span class="p">);</span>

    <span class="kt">var</span> <span class="n">regionFactory</span> <span class="p">=</span> <span class="n">cache</span><span class="p">.</span><span class="nf">CreateRegionFactory</span><span class="p">(</span><span class="n">RegionShortcut</span><span class="p">.</span><span class="n">PROXY</span><span class="p">)</span>
         <span class="p">.</span><span class="nf">SetPoolName</span><span class="p">(</span><span class="s">"pool"</span><span class="p">);</span>
    <span class="kt">var</span> <span class="n">orderRegion</span> <span class="p">=</span> <span class="n">regionFactory</span><span class="p">.</span><span class="n">Create</span><span class="p">&lt;</span><span class="kt">int</span><span class="p">,</span> <span class="n">Order</span><span class="p">&gt;(</span><span class="s">"example_orderobject"</span><span class="p">);</span>
 </code></pre>

 <p>After declaring some keys and values, the client then stores and retrieves an <code>Order</code> object:</p>
 <pre class="highlight csharp"><code>    <span class="k">const</span> <span class="kt">int</span> <span class="n">orderKey</span> <span class="p">=</span> <span class="m">65</span><span class="p">;</span>

     <span class="kt">var</span> <span class="n">order</span> <span class="p">=</span> <span class="k">new</span> <span class="nf">Order</span><span class="p">(</span><span class="n">orderKey</span><span class="p">,</span> <span class="s">"Donuts"</span><span class="p">,</span> <span class="m">12</span><span class="p">);</span>

     <span class="n">Console</span><span class="p">.</span><span class="nf">WriteLine</span><span class="p">(</span><span class="s">"order to put is "</span> <span class="p">+</span> <span class="n">order</span><span class="p">);</span>
     <span class="n">orderRegion</span><span class="p">.</span><span class="nf">Put</span><span class="p">(</span><span class="n">orderKey</span><span class="p">,</span> <span class="n">order</span><span class="p">,</span> <span class="k">null</span><span class="p">);</span>

     <span class="n">Console</span><span class="p">.</span><span class="nf">WriteLine</span><span class="p">(</span><span class="s">"Successfully put order, getting now..."</span><span class="p">);</span>
     <span class="kt">var</span> <span class="n">orderRetrieved</span> <span class="p">=</span> <span class="n">orderRegion</span><span class="p">.</span><span class="nf">Get</span><span class="p">(</span><span class="n">orderKey</span><span class="p">,</span> <span class="k">null</span><span class="p">);</span>

     <span class="n">Console</span><span class="p">.</span><span class="nf">WriteLine</span><span class="p">(</span><span class="s">"Order key: "</span> <span class="p">+</span> <span class="n">orderKey</span> <span class="p">+</span> <span class="s">" = "</span> <span class="p">+</span> <span class="n">orderRetrieved</span><span class="p">);</span>
 </code></pre>

 <p>Finally, the application closes the cache:</p>
 <pre class="highlight csharp"><code>    <span class="n">cache</span><span class="p">.</span><span class="nf">Close</span><span class="p">();</span>
 </code></pre>


       </main>
     </div>
   </div>
 </div>

 <div id="scrim"></div>

 <div class="container">
   <footer class="site-footer-links">
     <!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
 <div class="copyright">
   <a href='/'>Apache Geode Documentation</a>
   &copy; 2020 <a href='http://www.apache.org/'>The Apache Software Foundation</a>.
 </div>
 <div class="support">
   Need help? <a href="http://geode.apache.org/community" target="_blank">Visit the Community</a>
 </div>

   </footer>
 </div><!--end of container-->

 </body>
 </html>