generic-library/msgpack
1
0
Fork 0
mirror of https://github.com/msgpack/msgpack-c.git synced 2026-01-04 20:43:19 +01:00
Code Issues Projects Releases Wiki Activity

Updated doc to 4.0.2

Browse Source
This commit is contained in:
Takatoshi Kondo
2021-08-31 15:12:16 +09:00
parent 96d587c87d
commit 8b5a2ebe8c
5186 changed files with 155895 additions and 75434 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
cpp/classmsgpack_1_1object__handle.html
View File

@@ -1,9 +1,9 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!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.13"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MessagePack for C++: msgpack::object_handle Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,18 +29,21 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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(); });
});
</script>
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -78,21 +81,25 @@ $(function() {
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad8f4b04d837eb9a66660d91c55a9bf4a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#ad8f4b04d837eb9a66660d91c55a9bf4a">object_handle</a> ()</td></tr>
<tr class="memdesc:ad8f4b04d837eb9a66660d91c55a9bf4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that creates nil object and null zone. <a href="#ad8f4b04d837eb9a66660d91c55a9bf4a">More...</a><br /></td></tr>
<tr class="memdesc:ad8f4b04d837eb9a66660d91c55a9bf4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that creates nil object and null zone. <a href="classmsgpack_1_1object__handle.html#ad8f4b04d837eb9a66660d91c55a9bf4a">More...</a><br /></td></tr>
<tr class="separator:ad8f4b04d837eb9a66660d91c55a9bf4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00d009663dd8ee0e904280c519531522"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#a00d009663dd8ee0e904280c519531522">object_handle</a> (<a class="el" href="structmsgpack_1_1object.html">msgpack::object</a> const &amp;obj, <a class="el" href="structmsgpack_1_1unique__ptr.html">msgpack::unique_ptr</a>&lt; <a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a> &gt; &amp;&amp;z)</td></tr>
<tr class="memdesc:a00d009663dd8ee0e904280c519531522"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that creates an <a class="el" href="classmsgpack_1_1object__handle.html" title="The class holds object and zone. ">object_handle</a> holding object <code>obj</code> and zone <code>z</code>. <a href="#a00d009663dd8ee0e904280c519531522">More...</a><br /></td></tr>
<tr class="memitem:a00d009663dd8ee0e904280c519531522"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#a00d009663dd8ee0e904280c519531522">object_handle</a> (<a class="el" href="structmsgpack_1_1object.html">msgpack::object</a> const &amp;obj, msgpack::unique_ptr&lt; <a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a> &gt; &amp;&amp;z)</td></tr>
<tr class="memdesc:a00d009663dd8ee0e904280c519531522"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that creates an <a class="el" href="classmsgpack_1_1object__handle.html" title="The class holds object and zone.">object_handle</a> holding object <code>obj</code> and zone <code>z</code>. <a href="classmsgpack_1_1object__handle.html#a00d009663dd8ee0e904280c519531522">More...</a><br /></td></tr>
<tr class="separator:a00d009663dd8ee0e904280c519531522"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadf3cdc152b8463a2aa0b5af728d3454"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#aadf3cdc152b8463a2aa0b5af728d3454">set</a> (<a class="el" href="structmsgpack_1_1object.html">msgpack::object</a> const &amp;obj)</td></tr>
<tr class="separator:aadf3cdc152b8463a2aa0b5af728d3454"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a7ec128fae9afd93bc69e1db7fff1a5"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structmsgpack_1_1object.html">msgpack::object</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#a2a7ec128fae9afd93bc69e1db7fff1a5">get</a> () const</td></tr>
<tr class="memdesc:a2a7ec128fae9afd93bc69e1db7fff1a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get object reference. <a href="#a2a7ec128fae9afd93bc69e1db7fff1a5">More...</a><br /></td></tr>
<tr class="memdesc:a2a7ec128fae9afd93bc69e1db7fff1a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get object reference. <a href="classmsgpack_1_1object__handle.html#a2a7ec128fae9afd93bc69e1db7fff1a5">More...</a><br /></td></tr>
<tr class="separator:a2a7ec128fae9afd93bc69e1db7fff1a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96356fdba1681dd1e0f31404e5e75687"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmsgpack_1_1unique__ptr.html">msgpack::unique_ptr</a>&lt; <a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#a96356fdba1681dd1e0f31404e5e75687">zone</a> ()</td></tr>
<tr class="memdesc:a96356fdba1681dd1e0f31404e5e75687"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get <a class="el" href="structmsgpack_1_1unique__ptr.html">unique_ptr</a> reference of zone. <a href="#a96356fdba1681dd1e0f31404e5e75687">More...</a><br /></td></tr>
<tr class="memitem:a5c319d24341da989199dc2bfba441c8b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structmsgpack_1_1object.html">msgpack::object</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#a5c319d24341da989199dc2bfba441c8b">operator*</a> () const</td></tr>
<tr class="separator:a5c319d24341da989199dc2bfba441c8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e94406ed1570db3994dd73ef6efe5e8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structmsgpack_1_1object.html">msgpack::object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#a2e94406ed1570db3994dd73ef6efe5e8">operator-&gt;</a> () const</td></tr>
<tr class="separator:a2e94406ed1570db3994dd73ef6efe5e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96356fdba1681dd1e0f31404e5e75687"><td class="memItemLeft" align="right" valign="top">msgpack::unique_ptr&lt; <a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#a96356fdba1681dd1e0f31404e5e75687">zone</a> ()</td></tr>
<tr class="memdesc:a96356fdba1681dd1e0f31404e5e75687"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get unique_ptr reference of zone. <a href="classmsgpack_1_1object__handle.html#a96356fdba1681dd1e0f31404e5e75687">More...</a><br /></td></tr>
<tr class="separator:a96356fdba1681dd1e0f31404e5e75687"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c7d02e8420041e9a737d9ed4e3ba711"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structmsgpack_1_1unique__ptr.html">msgpack::unique_ptr</a>&lt; <a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#a2c7d02e8420041e9a737d9ed4e3ba711">zone</a> () const</td></tr>
<tr class="memdesc:a2c7d02e8420041e9a737d9ed4e3ba711"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get <a class="el" href="structmsgpack_1_1unique__ptr.html">unique_ptr</a> const reference of zone. <a href="#a2c7d02e8420041e9a737d9ed4e3ba711">More...</a><br /></td></tr>
<tr class="memitem:a2c7d02e8420041e9a737d9ed4e3ba711"><td class="memItemLeft" align="right" valign="top">const msgpack::unique_ptr&lt; <a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1object__handle.html#a2c7d02e8420041e9a737d9ed4e3ba711">zone</a> () const</td></tr>
<tr class="memdesc:a2c7d02e8420041e9a737d9ed4e3ba711"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get unique_ptr const reference of zone. <a href="classmsgpack_1_1object__handle.html#a2c7d02e8420041e9a737d9ed4e3ba711">More...</a><br /></td></tr>
<tr class="separator:a2c7d02e8420041e9a737d9ed4e3ba711"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@@ -143,7 +150,7 @@ Public Member Functions</h2></td></tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmsgpack_1_1unique__ptr.html">msgpack::unique_ptr</a>&lt; <a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a> &gt; &amp;&amp;&#160;</td>
<td class="paramtype">msgpack::unique_ptr&lt; <a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a> &gt; &amp;&amp;&#160;</td>
<td class="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
@@ -159,7 +166,7 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Constructor that creates an <a class="el" href="classmsgpack_1_1object__handle.html" title="The class holds object and zone. ">object_handle</a> holding object <code>obj</code> and zone <code>z</code>. </p>
<p>Constructor that creates an <a class="el" href="classmsgpack_1_1object__handle.html" title="The class holds object and zone.">object_handle</a> holding object <code>obj</code> and zone <code>z</code>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>object </td></tr>
@@ -197,6 +204,64 @@ Public Member Functions</h2></td></tr>
<p>Get object reference. </p>
<dl class="section return"><dt>Returns</dt><dd>object </dd></dl>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1object__handle.html#a5c319d24341da989199dc2bfba441c8b">operator*()</a>, and <a class="el" href="classmsgpack_1_1object__handle.html#a2e94406ed1570db3994dd73ef6efe5e8">operator-&gt;()</a>.</p>
</div>
</div>
<a id="a5c319d24341da989199dc2bfba441c8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c319d24341da989199dc2bfba441c8b">&#9670;&nbsp;</a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structmsgpack_1_1object.html">msgpack::object</a>&amp; msgpack::object_handle::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>object (to mimic smart pointers). </dd></dl>
<p class="reference">References <a class="el" href="classmsgpack_1_1object__handle.html#a2a7ec128fae9afd93bc69e1db7fff1a5">get()</a>.</p>
</div>
</div>
<a id="a2e94406ed1570db3994dd73ef6efe5e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e94406ed1570db3994dd73ef6efe5e8">&#9670;&nbsp;</a></span>operator-&gt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structmsgpack_1_1object.html">msgpack::object</a>* msgpack::object_handle::operator-&gt; </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the address of the object (to mimic smart pointers). </dd></dl>
<p class="reference">References <a class="el" href="classmsgpack_1_1object__handle.html#a2a7ec128fae9afd93bc69e1db7fff1a5">get()</a>.</p>
</div>
</div>
<a id="aadf3cdc152b8463a2aa0b5af728d3454"></a>
@@ -223,7 +288,7 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#a0c5635fe757eb3b6dc229e343360e5a6">msgpack::unpacker::next()</a>, <a class="el" href="namespacemsgpack.html#ab17b94628f56c1877b8998f921b14a5c">msgpack::unpack()</a>, and <a class="el" href="classmsgpack_1_1unpacker.html#a786c115bb4f50f608007b4e6715d3666">msgpack::unpacker::visitor()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#a0c5635fe757eb3b6dc229e343360e5a6">msgpack::unpacker::next()</a>, and <a class="el" href="namespacemsgpack.html#ab17b94628f56c1877b8998f921b14a5c">msgpack::unpack()</a>.</p>
</div>
</div>
@@ -237,7 +302,7 @@ Public Member Functions</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmsgpack_1_1unique__ptr.html">msgpack::unique_ptr</a>&lt;<a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a>&gt;&amp; msgpack::object_handle::zone </td>
<td class="memname">msgpack::unique_ptr&lt;<a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a>&gt;&amp; msgpack::object_handle::zone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
@@ -250,10 +315,10 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Get <a class="el" href="structmsgpack_1_1unique__ptr.html">unique_ptr</a> reference of zone. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structmsgpack_1_1unique__ptr.html">unique_ptr</a> reference of zone </dd></dl>
<p>Get unique_ptr reference of zone. </p>
<dl class="section return"><dt>Returns</dt><dd>unique_ptr reference of zone </dd></dl>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#a0c5635fe757eb3b6dc229e343360e5a6">msgpack::unpacker::next()</a>, <a class="el" href="namespacemsgpack.html#ab17b94628f56c1877b8998f921b14a5c">msgpack::unpack()</a>, and <a class="el" href="classmsgpack_1_1unpacker.html#a786c115bb4f50f608007b4e6715d3666">msgpack::unpacker::visitor()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#a0c5635fe757eb3b6dc229e343360e5a6">msgpack::unpacker::next()</a>, and <a class="el" href="namespacemsgpack.html#ab17b94628f56c1877b8998f921b14a5c">msgpack::unpack()</a>.</p>
</div>
</div>
@@ -267,7 +332,7 @@ Public Member Functions</h2></td></tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structmsgpack_1_1unique__ptr.html">msgpack::unique_ptr</a>&lt;<a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a>&gt;&amp; msgpack::object_handle::zone </td>
<td class="memname">const msgpack::unique_ptr&lt;<a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a>&gt;&amp; msgpack::object_handle::zone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
@@ -280,22 +345,18 @@ Public Member Functions</h2></td></tr>
</table>
</div><div class="memdoc">
<p>Get <a class="el" href="structmsgpack_1_1unique__ptr.html">unique_ptr</a> const reference of zone. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structmsgpack_1_1unique__ptr.html">unique_ptr</a> const reference of zone </dd></dl>
<p class="reference">References <a class="el" href="namespacemsgpack.html#a0dae22dcd0fa979a5b05ad81d23ae71b">msgpack::move()</a>.</p>
<p>Get unique_ptr const reference of zone. </p>
<dl class="section return"><dt>Returns</dt><dd>unique_ptr const reference of zone </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/kondo/work/msgpack-c/include/msgpack/v1/<a class="el" href="v1_2object_8hpp_source.html">object.hpp</a></li>
<li>msgpack/v1/<a class="el" href="v1_2object_8hpp_source.html">object.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>