blob: f53827c0dbb8985730aaa5e73c929a65cec99009 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Geode Native .NET Reference: Apache::Geode::Client::IPdxSerializable Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache Geode Native .NET Reference
&#160;<span id="projectnumber">1.13.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00978.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Apache::Geode::Client::IPdxSerializable Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>When a domain class implements PdxSerializable it marks itself as a PDX.
<a href="a00978.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9ef9516b729bda4cfdd3815f277051b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00978.html#a9ef9516b729bda4cfdd3815f277051b7">FromData</a> (<a class="el" href="a00974.html">IPdxReader</a>^ reader)</td></tr>
<tr class="memdesc:a9ef9516b729bda4cfdd3815f277051b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserialize this object. <a href="#a9ef9516b729bda4cfdd3815f277051b7">More...</a><br /></td></tr>
<tr class="separator:a9ef9516b729bda4cfdd3815f277051b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7474ae1c1adf439e7e95e8805fae9b4c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00978.html#a7474ae1c1adf439e7e95e8805fae9b4c">ToData</a> (<a class="el" href="a00994.html">IPdxWriter</a>^ writer)</td></tr>
<tr class="memdesc:a7474ae1c1adf439e7e95e8805fae9b4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes this object in geode PDX format. <a href="#a7474ae1c1adf439e7e95e8805fae9b4c">More...</a><br /></td></tr>
<tr class="separator:a7474ae1c1adf439e7e95e8805fae9b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>When a domain class implements PdxSerializable it marks itself as a PDX. </p>
<p>The implementation of toData provides the serialization code and fromData provides the deserialization code. These methods also define each field name and field type of the PDX. Domain classes should serialize and de-serialize all its member fields in same order in toData and fromData method. A domain class which implements this interface should register delgate Serializable.RegisterPdxType to create new instance of type for de-serilization. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9ef9516b729bda4cfdd3815f277051b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ef9516b729bda4cfdd3815f277051b7">&#9670;&nbsp;</a></span>FromData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Apache::Geode::Client::IPdxSerializable::FromData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00974.html">IPdxReader</a>^&#160;</td>
<td class="paramname"><em>reader</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deserialize this object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>the <a class="el" href="a00974.html" title="A IPdxReader will be passed to IPdxSerializable.fromData or during deserialization of a PDX.">IPdxReader</a> stream to use for reading the object data </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7474ae1c1adf439e7e95e8805fae9b4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7474ae1c1adf439e7e95e8805fae9b4c">&#9670;&nbsp;</a></span>ToData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Apache::Geode::Client::IPdxSerializable::ToData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00994.html">IPdxWriter</a>^&#160;</td>
<td class="paramname"><em>writer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Serializes this object in geode PDX format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">writer</td><td>the <a class="el" href="a00994.html" title="A IPdxWriter will be passed to IPdxSerializable.toData when it is serializing the domain class.">IPdxWriter</a> object to use for serializing the object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!--
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.
-->
<HR><address style="align: right;"><small>Apache Geode C++ Cache .NET API Documentation</small></address>