generic-library/msgpack
1
0
Fork 0
mirror of https://github.com/msgpack/msgpack-c.git synced 2025-04-23 00:48:54 +02:00
Code Issues Projects Releases Wiki Activity
msgpack/cpp/classmsgpack_1_1object__handle.html
Takatoshi Kondo 96d587c87d Updated doc to 2.1.3
2017-06-30 11:05:26 +09:00

302 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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="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"/>
<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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MessagePack for C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="namespacemsgpack.html">msgpack</a></li><li class="navelem"><a class="el" href="classmsgpack_1_1object__handle.html">object_handle</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmsgpack_1_1object__handle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">msgpack::object_handle Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The class holds object and zone.
<a href="classmsgpack_1_1object__handle.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="v1_2object_8hpp_source.html">object.hpp</a>&gt;</code></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: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="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="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="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="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="separator:a2c7d02e8420041e9a737d9ed4e3ba711"><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>The class holds object and zone. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad8f4b04d837eb9a66660d91c55a9bf4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8f4b04d837eb9a66660d91c55a9bf4a">&#9670;&nbsp;</a></span>object_handle() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">msgpack::object_handle::object_handle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor that creates nil object and null zone. </p>
</div>
</div>
<a id="a00d009663dd8ee0e904280c519531522"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00d009663dd8ee0e904280c519531522">&#9670;&nbsp;</a></span>object_handle() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">msgpack::object_handle::object_handle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack_1_1object.html">msgpack::object</a> const &amp;&#160;</td>
<td class="paramname"><em>obj</em>, </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="paramname"><em>z</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj</td><td>object </td></tr>
<tr><td class="paramname">z</td><td>zone </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2a7ec128fae9afd93bc69e1db7fff1a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2a7ec128fae9afd93bc69e1db7fff1a5">&#9670;&nbsp;</a></span>get()</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::get </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">
<p>Get object reference. </p>
<dl class="section return"><dt>Returns</dt><dd>object </dd></dl>
</div>
</div>
<a id="aadf3cdc152b8463a2aa0b5af728d3454"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadf3cdc152b8463a2aa0b5af728d3454">&#9670;&nbsp;</a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::object_handle::set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack_1_1object.html">msgpack::object</a> const &amp;&#160;</td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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>
</div>
</div>
<a id="a96356fdba1681dd1e0f31404e5e75687"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96356fdba1681dd1e0f31404e5e75687">&#9670;&nbsp;</a></span>zone() <span class="overload">[1/2]</span></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="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>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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 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>
</div>
</div>
<a id="a2c7d02e8420041e9a737d9ed4e3ba711"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c7d02e8420041e9a737d9ed4e3ba711">&#9670;&nbsp;</a></span>zone() <span class="overload">[2/2]</span></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_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>(</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">
<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>
</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>
</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
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink