blob: ddd76a88a64ba80e443a8f0fc9ebd9cd8c0f724f [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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&nbsp; Apache Ignite C++: binary_object.h Source File</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="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="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_88bd599177f4cc5007b9f053025b0bc5.html">binary</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">binary_object.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="binary__object_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * this work for additional information regarding copyright ownership.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * (the &quot;License&quot;); you may not use this file except in compliance with</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the License. You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef _IGNITE_BINARY_BINARY_OBJECT</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define _IGNITE_BINARY_BINARY_OBJECT</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;ignite/impl/binary/binary_object_impl.h&gt;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceignite.html">ignite</a></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">namespace </span>impl</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">namespace </span>binary</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">class </span>BinaryWriterImpl;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; }</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keyword">namespace </span>binary</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; {</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryObject.html"> 48</a></span>&#160; <span class="keyword">class </span>IGNITE_IMPORT_EXPORT <a class="code" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>ignite::impl::binary::BinaryWriterImpl;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <a class="code" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a>(<span class="keyword">const</span> impl::binary::BinaryObjectImpl&amp; impl) :</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; impl(impl)</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; {</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <a class="code" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a>(impl::interop::InteropMemory&amp; mem, int32_t start,</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; impl::binary::BinaryIdResolver* idRslvr, impl::binary::BinaryTypeManager* metaMgr) :</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; impl(mem, start, idRslvr, metaMgr)</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; {</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; }</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; </div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryObject.html#a33e2264ff8c984c59b5578b8d285af68"> 86</a></span>&#160; <a class="code" href="classignite_1_1binary_1_1BinaryObject.html#a33e2264ff8c984c59b5578b8d285af68">BinaryObject</a>(<span class="keyword">const</span> <a class="code" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a>&amp; other) :</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; impl(other.impl)</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; {</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="comment">// No-op.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryObject.html#af334348d8a3dfa3524d5e671c6a256ca"> 98</a></span>&#160; <a class="code" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a>&amp; <a class="code" href="classignite_1_1binary_1_1BinaryObject.html#af334348d8a3dfa3524d5e671c6a256ca">operator=</a>(<span class="keyword">const</span> <a class="code" href="classignite_1_1binary_1_1BinaryObject.html">BinaryObject</a>&amp; other)</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; {</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; impl = other.impl;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; }</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryObject.html#aa6fec1748035deed676bb04942a0a7c1"> 113</a></span>&#160; T <a class="code" href="classignite_1_1binary_1_1BinaryObject.html#aa6fec1748035deed676bb04942a0a7c1">Deserialize</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordflow">return</span> impl.Deserialize&lt;T&gt;();</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; }</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryObject.html#a27cda9ca714886910ada1b62c76f59e4"> 127</a></span>&#160; T <a class="code" href="classignite_1_1binary_1_1BinaryObject.html#a27cda9ca714886910ada1b62c76f59e4">GetField</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name)<span class="keyword"> const</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; <span class="keywordflow">return</span> impl.GetField&lt;T&gt;(name);</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; }</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; </div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="classignite_1_1binary_1_1BinaryObject.html#a001112359409827867634b664666b524"> 139</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classignite_1_1binary_1_1BinaryObject.html#a001112359409827867634b664666b524">HasField</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name)<span class="keyword"> const</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; <span class="keywordflow">return</span> impl.HasField(name);</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; }</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160; </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; impl::binary::BinaryObjectImpl impl;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; };</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; <span class="comment">/* Specialization */</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160; <span class="keyword">template</span>&lt;&gt;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keyword">inline</span> BinaryObject <a class="code" href="classignite_1_1binary_1_1BinaryObject.html#a27cda9ca714886910ada1b62c76f59e4">BinaryObject::GetField</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name)<span class="keyword"> const</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classignite_1_1binary_1_1BinaryObject.html#a33e2264ff8c984c59b5578b8d285af68">BinaryObject</a>(impl.GetField&lt;impl::binary::BinaryObjectImpl&gt;(name));</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; }</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; }</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;}</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; </div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;<span class="preprocessor">#endif //_IGNITE_BINARY_BINARY_OBJECT</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryObject_html"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryObject.html">ignite::binary::BinaryObject</a></div><div class="ttdoc">Binary object.</div><div class="ttdef"><b>Definition:</b> binary_object.h:48</div></div>
<div class="ttc" id="anamespaceignite_html"><div class="ttname"><a href="namespaceignite.html">ignite</a></div><div class="ttdoc">Apache Ignite API.</div><div class="ttdef"><b>Definition:</b> cache.h:48</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryObject_html_a33e2264ff8c984c59b5578b8d285af68"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryObject.html#a33e2264ff8c984c59b5578b8d285af68">ignite::binary::BinaryObject::BinaryObject</a></div><div class="ttdeci">BinaryObject(const BinaryObject &amp;other)</div><div class="ttdoc">Copy constructor.</div><div class="ttdef"><b>Definition:</b> binary_object.h:86</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryObject_html_af334348d8a3dfa3524d5e671c6a256ca"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryObject.html#af334348d8a3dfa3524d5e671c6a256ca">ignite::binary::BinaryObject::operator=</a></div><div class="ttdeci">BinaryObject &amp; operator=(const BinaryObject &amp;other)</div><div class="ttdoc">Assignment operator.</div><div class="ttdef"><b>Definition:</b> binary_object.h:98</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryObject_html_aa6fec1748035deed676bb04942a0a7c1"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryObject.html#aa6fec1748035deed676bb04942a0a7c1">ignite::binary::BinaryObject::Deserialize</a></div><div class="ttdeci">T Deserialize() const</div><div class="ttdoc">Deserialize object.</div><div class="ttdef"><b>Definition:</b> binary_object.h:113</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryObject_html_a001112359409827867634b664666b524"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryObject.html#a001112359409827867634b664666b524">ignite::binary::BinaryObject::HasField</a></div><div class="ttdeci">bool HasField(const char *name) const</div><div class="ttdoc">Check if the binary object has the specified field.</div><div class="ttdef"><b>Definition:</b> binary_object.h:139</div></div>
<div class="ttc" id="aclassignite_1_1binary_1_1BinaryObject_html_a27cda9ca714886910ada1b62c76f59e4"><div class="ttname"><a href="classignite_1_1binary_1_1BinaryObject.html#a27cda9ca714886910ada1b62c76f59e4">ignite::binary::BinaryObject::GetField</a></div><div class="ttdeci">T GetField(const char *name) const</div><div class="ttdoc">Get field.</div><div class="ttdef"><b>Definition:</b> binary_object.h:127</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 10 2022 11:02:04 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>