| <!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::TypeRegistry Class 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&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 |
|  <span id="projectnumber">1.13.0</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&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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a01138.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> | |
| <a href="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::TypeRegistry Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Registry for custom serializable types, both PDXSerializable and DataSerializable. |
| <a href="a01138.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:ad0b77cec60fe8eb8c264d7b140c7381a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01138.html#ad0b77cec60fe8eb8c264d7b140c7381a">RegisterPdxType</a> (<a class="el" href="a00382.html#a7976afcda91defe8dccb2945b71dc9c6">PdxTypeFactoryMethod</a>^ creationMethod)</td></tr> |
| <tr class="memdesc:ad0b77cec60fe8eb8c264d7b140c7381a"><td class="mdescLeft"> </td><td class="mdescRight">Register an instance factory method for a given type. <a href="#ad0b77cec60fe8eb8c264d7b140c7381a">More...</a><br /></td></tr> |
| <tr class="separator:ad0b77cec60fe8eb8c264d7b140c7381a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ea41f2e4c9cbd475b41fc7243bea144"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01138.html#a2ea41f2e4c9cbd475b41fc7243bea144">RegisterType</a> (<a class="el" href="a00382.html#ab4f8e3def2c048935fa696daacaec531">TypeFactoryMethod</a>^ creationMethod, int32_t id)</td></tr> |
| <tr class="memdesc:a2ea41f2e4c9cbd475b41fc7243bea144"><td class="mdescLeft"> </td><td class="mdescRight">Register an instance factory method for a given type. <a href="#a2ea41f2e4c9cbd475b41fc7243bea144">More...</a><br /></td></tr> |
| <tr class="separator:a2ea41f2e4c9cbd475b41fc7243bea144"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:af39a19b0a644a454457ff5e6f8484b66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00986.html">IPdxTypeMapper</a>^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a01138.html#af39a19b0a644a454457ff5e6f8484b66">PdxTypeMapper</a><code> [get, set]</code></td></tr> |
| <tr class="memdesc:af39a19b0a644a454457ff5e6f8484b66"><td class="mdescLeft"> </td><td class="mdescRight">Register an PdxTypeMapper to map the local types to pdx types <a href="#af39a19b0a644a454457ff5e6f8484b66">More...</a><br /></td></tr> |
| <tr class="separator:af39a19b0a644a454457ff5e6f8484b66"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Registry for custom serializable types, both PDXSerializable and DataSerializable. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ad0b77cec60fe8eb8c264d7b140c7381a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad0b77cec60fe8eb8c264d7b140c7381a">◆ </a></span>RegisterPdxType()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache::Geode::Client::TypeRegistry::RegisterPdxType </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00382.html#a7976afcda91defe8dccb2945b71dc9c6">PdxTypeFactoryMethod</a>^ </td> |
| <td class="paramname"><em>creationMethod</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Register an instance factory method for a given type. </p> |
| <p>This should be used when registering types that implement <a class="el" href="a00978.html" title="When a domain class implements PdxSerializable it marks itself as a PDX.">IPdxSerializable</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">creationMethod</td><td>the creation function to register </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>if the method is null </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a2ea41f2e4c9cbd475b41fc7243bea144"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2ea41f2e4c9cbd475b41fc7243bea144">◆ </a></span>RegisterType()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache::Geode::Client::TypeRegistry::RegisterType </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00382.html#ab4f8e3def2c048935fa696daacaec531">TypeFactoryMethod</a>^ </td> |
| <td class="paramname"><em>creationMethod</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>id</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Register an instance factory method for a given type. </p> |
| <p>This should be used when registering types that implement <a class="el" href="a01022.html" title="This interface class is the superclass of all user objects in the cache that can be serialized.">ISerializable</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">creationMethod</td><td>the creation function to register </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>if the method is null </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if the typeId has already been registered, or there is an error in registering the type; check <code><a class="el" href="a01146.html#a31c5586fce17003ceadd586677faa13c" title="Utility method to get the calling thread's last system error code.">Utils::LastError</a></code> for more information in the latter case. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="af39a19b0a644a454457ff5e6f8484b66"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af39a19b0a644a454457ff5e6f8484b66">◆ </a></span>PdxTypeMapper</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00986.html">IPdxTypeMapper</a>^ Apache::Geode::Client::TypeRegistry::PdxTypeMapper</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Register an PdxTypeMapper to map the local types to pdx types </p> |
| |
| </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> |