generic-library/msgpack
1
0
Fork 0
mirror of https://github.com/msgpack/msgpack-c.git synced 2025-04-19 15:47:15 +02:00
Code Issues Projects Releases Wiki Activity
msgpack/cpp/classmsgpack_1_1unpacker.html
Takatoshi Kondo 8b5a2ebe8c Updated doc to 4.0.2
2021-08-31 15:12:16 +09:00

885 lines
49 KiB
HTML
Raw Permalink Blame History

<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MessagePack for C++: msgpack::unpacker 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.9.1 -->
<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','.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(); });
});
/* @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="namespacemsgpack.html">msgpack</a></li><li class="navelem"><a class="el" href="classmsgpack_1_1unpacker.html">unpacker</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_1unpacker-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">msgpack::unpacker Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Unpacking class for a stream deserialization.
<a href="classmsgpack_1_1unpacker.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="v1_2unpack_8hpp_source.html">unpack.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:a84ce4b4e9063e689315eda16a07ebee6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a84ce4b4e9063e689315eda16a07ebee6">unpacker</a> (<a class="el" href="namespacemsgpack.html#a74841406f4ad1b1b1bf51d5290418697">unpack_reference_func</a> f=&amp;unpacker::default_reference_func, void *user_data=<a class="el" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>, std::size_t initial_buffer_size=<a class="el" href="v1_2unpack__decl_8hpp.html#a425e3370ec89bc0a8ebc645d8d7f3d7f">MSGPACK_UNPACKER_INIT_BUFFER_SIZE</a>, <a class="el" href="classmsgpack_1_1unpack__limit.html">unpack_limit</a> const &amp;limit=<a class="el" href="classmsgpack_1_1unpack__limit.html">unpack_limit</a>())</td></tr>
<tr class="memdesc:a84ce4b4e9063e689315eda16a07ebee6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classmsgpack_1_1unpacker.html#a84ce4b4e9063e689315eda16a07ebee6">More...</a><br /></td></tr>
<tr class="separator:a84ce4b4e9063e689315eda16a07ebee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa697f9bb1b4c61370d9fa7ff9a2e23ad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#aa697f9bb1b4c61370d9fa7ff9a2e23ad">unpacker</a> (<a class="el" href="classmsgpack_1_1unpacker.html">unpacker</a> &amp;&amp;other)</td></tr>
<tr class="separator:aa697f9bb1b4c61370d9fa7ff9a2e23ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed1675fabb56dd9c6d464882619d9d3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmsgpack_1_1unpacker.html">unpacker</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#aed1675fabb56dd9c6d464882619d9d3f">operator=</a> (<a class="el" href="classmsgpack_1_1unpacker.html">unpacker</a> &amp;&amp;other)</td></tr>
<tr class="separator:aed1675fabb56dd9c6d464882619d9d3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a431237f15de761fd97e1915809d37b1e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a431237f15de761fd97e1915809d37b1e">~unpacker</a> ()</td></tr>
<tr class="separator:a431237f15de761fd97e1915809d37b1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09c1f8d79b01ee69824c47c32665da26"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a09c1f8d79b01ee69824c47c32665da26">reserve_buffer</a> (std::size_t size=<a class="el" href="v1_2unpack__decl_8hpp.html#a4387f358acd5455b09dedd1d1bb6ea0e">MSGPACK_UNPACKER_RESERVE_SIZE</a>)</td></tr>
<tr class="memdesc:a09c1f8d79b01ee69824c47c32665da26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserve a buffer memory. <a href="classmsgpack_1_1unpacker.html#a09c1f8d79b01ee69824c47c32665da26">More...</a><br /></td></tr>
<tr class="separator:a09c1f8d79b01ee69824c47c32665da26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab36a1c9268aa9b76f054365ab2e6b360"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#ab36a1c9268aa9b76f054365ab2e6b360">buffer</a> ()</td></tr>
<tr class="memdesc:ab36a1c9268aa9b76f054365ab2e6b360"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get buffer pointer. <a href="classmsgpack_1_1unpacker.html#ab36a1c9268aa9b76f054365ab2e6b360">More...</a><br /></td></tr>
<tr class="separator:ab36a1c9268aa9b76f054365ab2e6b360"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbed521398254480fee682f2ac23891d"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#adbed521398254480fee682f2ac23891d">buffer_capacity</a> () const</td></tr>
<tr class="memdesc:adbed521398254480fee682f2ac23891d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get buffer capacity. <a href="classmsgpack_1_1unpacker.html#adbed521398254480fee682f2ac23891d">More...</a><br /></td></tr>
<tr class="separator:adbed521398254480fee682f2ac23891d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80693fd49ccec34b77d60feb177e4bf7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a80693fd49ccec34b77d60feb177e4bf7">buffer_consumed</a> (std::size_t size)</td></tr>
<tr class="memdesc:a80693fd49ccec34b77d60feb177e4bf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notify a buffer consumed information to <a class="el" href="classmsgpack_1_1unpacker.html" title="Unpacking class for a stream deserialization.">msgpack::unpacker</a>. <a href="classmsgpack_1_1unpacker.html#a80693fd49ccec34b77d60feb177e4bf7">More...</a><br /></td></tr>
<tr class="separator:a80693fd49ccec34b77d60feb177e4bf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe8a6508ffa0a46606039f864fedbbab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#afe8a6508ffa0a46606039f864fedbbab">next</a> (<a class="el" href="classmsgpack_1_1object__handle.html">msgpack::object_handle</a> *result)</td></tr>
<tr class="memdesc:afe8a6508ffa0a46606039f864fedbbab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unpack one <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a>. [obsolete]. <a href="classmsgpack_1_1unpacker.html#afe8a6508ffa0a46606039f864fedbbab">More...</a><br /></td></tr>
<tr class="separator:afe8a6508ffa0a46606039f864fedbbab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c5635fe757eb3b6dc229e343360e5a6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a0c5635fe757eb3b6dc229e343360e5a6">next</a> (<a class="el" href="classmsgpack_1_1object__handle.html">msgpack::object_handle</a> &amp;result, bool &amp;referenced)</td></tr>
<tr class="memdesc:a0c5635fe757eb3b6dc229e343360e5a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unpack one <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a>. <a href="classmsgpack_1_1unpacker.html#a0c5635fe757eb3b6dc229e343360e5a6">More...</a><br /></td></tr>
<tr class="separator:a0c5635fe757eb3b6dc229e343360e5a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a867530ec395636826a4c4a0c32d740d9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a867530ec395636826a4c4a0c32d740d9">next</a> (<a class="el" href="classmsgpack_1_1object__handle.html">msgpack::object_handle</a> &amp;result)</td></tr>
<tr class="memdesc:a867530ec395636826a4c4a0c32d740d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unpack one <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a>. <a href="classmsgpack_1_1unpacker.html#a867530ec395636826a4c4a0c32d740d9">More...</a><br /></td></tr>
<tr class="separator:a867530ec395636826a4c4a0c32d740d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e65f6c8ff0575915f81eb2953ae2fe7"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a8e65f6c8ff0575915f81eb2953ae2fe7">message_size</a> () const</td></tr>
<tr class="memdesc:a8e65f6c8ff0575915f81eb2953ae2fe7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get message size. <a href="classmsgpack_1_1unpacker.html#a8e65f6c8ff0575915f81eb2953ae2fe7">More...</a><br /></td></tr>
<tr class="separator:a8e65f6c8ff0575915f81eb2953ae2fe7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfa3d1d984b4870e3b2cf9ff6af92b80"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#acfa3d1d984b4870e3b2cf9ff6af92b80">execute</a> ()</td></tr>
<tr class="separator:acfa3d1d984b4870e3b2cf9ff6af92b80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a679ecd1353331444af88c863a0217b0f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmsgpack_1_1object.html">msgpack::object</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a679ecd1353331444af88c863a0217b0f">data</a> ()</td></tr>
<tr class="separator:a679ecd1353331444af88c863a0217b0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03d7d745c9e677c555ad2fc7497eaabc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmsgpack_1_1zone.html">msgpack::zone</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a03d7d745c9e677c555ad2fc7497eaabc">release_zone</a> ()</td></tr>
<tr class="separator:a03d7d745c9e677c555ad2fc7497eaabc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0eb7d17a7d7962f8871a2ef8f2414e1e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a0eb7d17a7d7962f8871a2ef8f2414e1e">reset_zone</a> ()</td></tr>
<tr class="separator:a0eb7d17a7d7962f8871a2ef8f2414e1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0095eaf0945754f209b7ca77805790a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#ad0095eaf0945754f209b7ca77805790a">reset</a> ()</td></tr>
<tr class="separator:ad0095eaf0945754f209b7ca77805790a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a875d9c169c29c106152c292b6d3829f7"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a875d9c169c29c106152c292b6d3829f7">parsed_size</a> () const</td></tr>
<tr class="memdesc:a875d9c169c29c106152c292b6d3829f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get parsed message size. <a href="classmsgpack_1_1unpacker.html#a875d9c169c29c106152c292b6d3829f7">More...</a><br /></td></tr>
<tr class="separator:a875d9c169c29c106152c292b6d3829f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5920fa741fd620f28aea62dd7b6184a"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#ab5920fa741fd620f28aea62dd7b6184a">nonparsed_buffer</a> ()</td></tr>
<tr class="memdesc:ab5920fa741fd620f28aea62dd7b6184a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the address that is not parsed in the buffer. <a href="classmsgpack_1_1unpacker.html#ab5920fa741fd620f28aea62dd7b6184a">More...</a><br /></td></tr>
<tr class="separator:ab5920fa741fd620f28aea62dd7b6184a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68279f3a1cfa5a26aefb62966cb8b907"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a68279f3a1cfa5a26aefb62966cb8b907">nonparsed_size</a> () const</td></tr>
<tr class="memdesc:a68279f3a1cfa5a26aefb62966cb8b907"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the size of the buffer that is not parsed. <a href="classmsgpack_1_1unpacker.html#a68279f3a1cfa5a26aefb62966cb8b907">More...</a><br /></td></tr>
<tr class="separator:a68279f3a1cfa5a26aefb62966cb8b907"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addac24de23663926c143992eb61df9af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#addac24de23663926c143992eb61df9af">skip_nonparsed_buffer</a> (std::size_t size)</td></tr>
<tr class="memdesc:addac24de23663926c143992eb61df9af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Skip the specified size of non-parsed buffer. <a href="classmsgpack_1_1unpacker.html#addac24de23663926c143992eb61df9af">More...</a><br /></td></tr>
<tr class="separator:addac24de23663926c143992eb61df9af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23e66e34461f979f3df08d63662fad28"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1unpacker.html#a23e66e34461f979f3df08d63662fad28">remove_nonparsed_buffer</a> ()</td></tr>
<tr class="memdesc:a23e66e34461f979f3df08d63662fad28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove nonparsed buffer and reset the current position as a new start point. <a href="classmsgpack_1_1unpacker.html#a23e66e34461f979f3df08d63662fad28">More...</a><br /></td></tr>
<tr class="separator:a23e66e34461f979f3df08d63662fad28"><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>Unpacking class for a stream deserialization. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a84ce4b4e9063e689315eda16a07ebee6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84ce4b4e9063e689315eda16a07ebee6">&#9670;&nbsp;</a></span>unpacker() <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::unpacker::unpacker </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacemsgpack.html#a74841406f4ad1b1b1bf51d5290418697">unpack_reference_func</a>&#160;</td>
<td class="paramname"><em>f</em> = <code>&amp;unpacker::default_reference_func</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>user_data</em> = <code><a class="el" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>initial_buffer_size</em> = <code><a class="el" href="v1_2unpack__decl_8hpp.html#a425e3370ec89bc0a8ebc645d8d7f3d7f">MSGPACK_UNPACKER_INIT_BUFFER_SIZE</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmsgpack_1_1unpack__limit.html">unpack_limit</a> const &amp;&#160;</td>
<td class="paramname"><em>limit</em> = <code><a class="el" href="classmsgpack_1_1unpack__limit.html">unpack_limit</a>()</code>&#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. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td>A judging function that <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a> refer to the buffer. </td></tr>
<tr><td class="paramname">user_data</td><td>This parameter is passed to f. </td></tr>
<tr><td class="paramname">initial_buffer_size</td><td>The memory size to allocate when unpacker is constructed. </td></tr>
<tr><td class="paramname">limit</td><td>The size limit information of <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a>. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="classmsgpack_1_1unpacker.html#ab36a1c9268aa9b76f054365ab2e6b360">buffer()</a>, <a class="el" href="v1_2unpack__decl_8hpp.html#a5719a92109d25731637a23bea69af0b7">COUNTER_SIZE</a>, <a class="el" href="classmsgpack_1_1detail_1_1context.html#ae0d157b928a8ed6d30115e6d7eed4913">msgpack::detail::context&lt; VisitorHolder &gt;::init()</a>, <a class="el" href="namespacemsgpack_1_1detail.html#a5138926c34b98462353d3ade9bcc2d0a">msgpack::detail::init_count()</a>, <a class="el" href="classmsgpack_1_1detail_1_1unpack__user.html#add02e5b68a217218df422b251bf1adef">msgpack::detail::unpack_user::set_referenced()</a>, <a class="el" href="classmsgpack_1_1detail_1_1unpack__user.html#ab066fd31f90eb168b3d0416112c35786">msgpack::detail::unpack_user::set_zone()</a>, and <a class="el" href="classmsgpack_1_1detail_1_1context.html#ac74485be61ea7a98565f1d496818eab1">msgpack::detail::context&lt; VisitorHolder &gt;::user()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#aed1675fabb56dd9c6d464882619d9d3f">operator=()</a>.</p>
</div>
</div>
<a id="aa697f9bb1b4c61370d9fa7ff9a2e23ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa697f9bb1b4c61370d9fa7ff9a2e23ad">&#9670;&nbsp;</a></span>unpacker() <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::unpacker::unpacker </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmsgpack_1_1unpacker.html">unpacker</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>other</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">References <a class="el" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>.</p>
</div>
</div>
<a id="a431237f15de761fd97e1915809d37b1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a431237f15de761fd97e1915809d37b1e">&#9670;&nbsp;</a></span>~unpacker()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">msgpack::unpacker::~unpacker </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 class="reference">References <a class="el" href="namespacemsgpack_1_1detail.html#aa58a1f1f0edbe279de50ed836c9a95a2">msgpack::detail::decr_count()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#aed1675fabb56dd9c6d464882619d9d3f">operator=()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab36a1c9268aa9b76f054365ab2e6b360"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab36a1c9268aa9b76f054365ab2e6b360">&#9670;&nbsp;</a></span>buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char * msgpack::unpacker::buffer </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 buffer pointer. </p>
<p>You need to care about the memory is enable between <a class="el" href="classmsgpack_1_1unpacker.html#ab36a1c9268aa9b76f054365ab2e6b360" title="Get buffer pointer.">buffer()</a> and <a class="el" href="classmsgpack_1_1unpacker.html#ab36a1c9268aa9b76f054365ab2e6b360" title="Get buffer pointer.">buffer()</a> + <a class="el" href="classmsgpack_1_1unpacker.html#adbed521398254480fee682f2ac23891d" title="Get buffer capacity.">buffer_capacity()</a> See: <a href="https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer">https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer</a> </p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#a84ce4b4e9063e689315eda16a07ebee6">unpacker()</a>.</p>
</div>
</div>
<a id="adbed521398254480fee682f2ac23891d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbed521398254480fee682f2ac23891d">&#9670;&nbsp;</a></span>buffer_capacity()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::size_t msgpack::unpacker::buffer_capacity </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 buffer capacity. </p>
<dl class="section return"><dt>Returns</dt><dd>The memory size that you can write.</dd></dl>
<p>See: <a href="https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer">https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer</a> </p>
</div>
</div>
<a id="a80693fd49ccec34b77d60feb177e4bf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80693fd49ccec34b77d60feb177e4bf7">&#9670;&nbsp;</a></span>buffer_consumed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::unpacker::buffer_consumed </td>
<td>(</td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>size</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>Notify a buffer consumed information to <a class="el" href="classmsgpack_1_1unpacker.html" title="Unpacking class for a stream deserialization.">msgpack::unpacker</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The size of memory that you consumed.</td></tr>
</table>
</dd>
</dl>
<p>After copying the data to the memory that is pointed by <a class="el" href="classmsgpack_1_1unpacker.html#ab36a1c9268aa9b76f054365ab2e6b360" title="Get buffer pointer.">buffer()</a>, you need to call the function to notify how many bytes are consumed. Then you can call <a class="el" href="classmsgpack_1_1unpacker.html#afe8a6508ffa0a46606039f864fedbbab" title="Unpack one msgpack::object. [obsolete].">next()</a> functions.</p>
<p>See: <a href="https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer">https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer</a> </p>
<p class="reference">References <a class="el" href="namespacemsgpack_1_1type.html#a7a061773204f4469948f1e39097da648">msgpack::type::size()</a>.</p>
</div>
</div>
<a id="a679ecd1353331444af88c863a0217b0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a679ecd1353331444af88c863a0217b0f">&#9670;&nbsp;</a></span>data()</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_1object.html">msgpack::object</a> const &amp; msgpack::unpacker::data </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>for backward compatibility </p>
<p class="reference">References <a class="el" href="classmsgpack_1_1detail_1_1context.html#a76c9574b34a3f7110a5e9e1d4ac5d239">msgpack::detail::context&lt; VisitorHolder &gt;::data()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#a0c5635fe757eb3b6dc229e343360e5a6">next()</a>.</p>
</div>
</div>
<a id="acfa3d1d984b4870e3b2cf9ff6af92b80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acfa3d1d984b4870e3b2cf9ff6af92b80">&#9670;&nbsp;</a></span>execute()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool msgpack::unpacker::execute </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>for backward compatibility </p>
</div>
</div>
<a id="a8e65f6c8ff0575915f81eb2953ae2fe7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e65f6c8ff0575915f81eb2953ae2fe7">&#9670;&nbsp;</a></span>message_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::size_t msgpack::unpacker::message_size </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 message size. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns <a class="el" href="classmsgpack_1_1unpacker.html#a875d9c169c29c106152c292b6d3829f7" title="Get parsed message size.">parsed_size()</a> + <a class="el" href="classmsgpack_1_1unpacker.html#a68279f3a1cfa5a26aefb62966cb8b907" title="Get the size of the buffer that is not parsed.">nonparsed_size()</a> </dd></dl>
</div>
</div>
<a id="a867530ec395636826a4c4a0c32d740d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a867530ec395636826a4c4a0c32d740d9">&#9670;&nbsp;</a></span>next() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool msgpack::unpacker::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmsgpack_1_1object__handle.html">msgpack::object_handle</a> &amp;&#160;</td>
<td class="paramname"><em>result</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>Unpack one <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>The object that contains unpacked data.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If one <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a> is unpacked, then return true, if <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a> is incomplete and additional data is required, then return false. If data format is invalid, throw <a class="el" href="structmsgpack_1_1parse__error.html">msgpack::parse_error</a>.</dd></dl>
<p>See: <a href="https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer">https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer</a> </p>
<p class="reference">References <a class="el" href="classmsgpack_1_1unpacker.html#afe8a6508ffa0a46606039f864fedbbab">next()</a>.</p>
</div>
</div>
<a id="a0c5635fe757eb3b6dc229e343360e5a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c5635fe757eb3b6dc229e343360e5a6">&#9670;&nbsp;</a></span>next() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool msgpack::unpacker::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmsgpack_1_1object__handle.html">msgpack::object_handle</a> &amp;&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool &amp;&#160;</td>
<td class="paramname"><em>referenced</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>Unpack one <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>The object that contains unpacked data. </td></tr>
<tr><td class="paramname">referenced</td><td>If the unpacked object contains reference of the buffer, then set as true, otherwise false.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If one <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a> is unpacked, then return true, if <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a> is incomplete and additional data is required, then return false. If data format is invalid, throw <a class="el" href="structmsgpack_1_1parse__error.html">msgpack::parse_error</a>.</dd></dl>
<p>See: <a href="https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer">https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer</a> </p>
<p class="reference">References <a class="el" href="classmsgpack_1_1unpacker.html#a679ecd1353331444af88c863a0217b0f">data()</a>, <a class="el" href="classmsgpack_1_1detail_1_1unpack__user.html#ad9de4f062647dd3989c7cb129c2fdbe5">msgpack::detail::unpack_user::referenced()</a>, <a class="el" href="classmsgpack_1_1unpacker.html#a03d7d745c9e677c555ad2fc7497eaabc">release_zone()</a>, <a class="el" href="classmsgpack_1_1unpacker.html#ad0095eaf0945754f209b7ca77805790a">reset()</a>, <a class="el" href="classmsgpack_1_1object__handle.html#aadf3cdc152b8463a2aa0b5af728d3454">msgpack::object_handle::set()</a>, <a class="el" href="classmsgpack_1_1detail_1_1context.html#ac74485be61ea7a98565f1d496818eab1">msgpack::detail::context&lt; VisitorHolder &gt;::user()</a>, and <a class="el" href="classmsgpack_1_1object__handle.html#a96356fdba1681dd1e0f31404e5e75687">msgpack::object_handle::zone()</a>.</p>
</div>
</div>
<a id="afe8a6508ffa0a46606039f864fedbbab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe8a6508ffa0a46606039f864fedbbab">&#9670;&nbsp;</a></span>next() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool msgpack::unpacker::next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmsgpack_1_1object__handle.html">msgpack::object_handle</a> *&#160;</td>
<td class="paramname"><em>result</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>Unpack one <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a>. [obsolete]. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">result</td><td>The object that contains unpacked data.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>If one <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a> is unpacked, then return true, if <a class="el" href="structmsgpack_1_1object.html" title="Object class that corresponding to MessagePack format object.">msgpack::object</a> is incomplete and additional data is required, then return false. If data format is invalid, throw <a class="el" href="structmsgpack_1_1parse__error.html">msgpack::parse_error</a>.</dd></dl>
<p>See: <a href="https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer">https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer</a> This function is obsolete. Use the reference inteface version of <a class="el" href="classmsgpack_1_1unpacker.html#afe8a6508ffa0a46606039f864fedbbab" title="Unpack one msgpack::object. [obsolete].">next()</a> function instead of the pointer interface version. </p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#a867530ec395636826a4c4a0c32d740d9">next()</a>.</p>
</div>
</div>
<a id="ab5920fa741fd620f28aea62dd7b6184a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5920fa741fd620f28aea62dd7b6184a">&#9670;&nbsp;</a></span>nonparsed_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char * msgpack::unpacker::nonparsed_buffer </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 the address that is not parsed in the buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>Address of the buffer that is not parsed</dd></dl>
<p>This function is usable when non-MessagePack message follows after MessagePack message. </p>
</div>
</div>
<a id="a68279f3a1cfa5a26aefb62966cb8b907"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68279f3a1cfa5a26aefb62966cb8b907">&#9670;&nbsp;</a></span>nonparsed_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::size_t msgpack::unpacker::nonparsed_size </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 the size of the buffer that is not parsed. </p>
<dl class="section return"><dt>Returns</dt><dd>Size of the buffer that is not parsed</dd></dl>
<p>This function is usable when non-MessagePack message follows after MessagePack message. </p>
</div>
</div>
<a id="aed1675fabb56dd9c6d464882619d9d3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed1675fabb56dd9c6d464882619d9d3f">&#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"><a class="el" href="classmsgpack_1_1unpacker.html">unpacker</a> &amp; msgpack::unpacker::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmsgpack_1_1unpacker.html">unpacker</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>other</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">References <a class="el" href="classmsgpack_1_1unpacker.html#a84ce4b4e9063e689315eda16a07ebee6">unpacker()</a>, and <a class="el" href="classmsgpack_1_1unpacker.html#a431237f15de761fd97e1915809d37b1e">~unpacker()</a>.</p>
</div>
</div>
<a id="a875d9c169c29c106152c292b6d3829f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a875d9c169c29c106152c292b6d3829f7">&#9670;&nbsp;</a></span>parsed_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::size_t msgpack::unpacker::parsed_size </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 parsed message size. </p>
<dl class="section return"><dt>Returns</dt><dd>Parsed message size.</dd></dl>
<p>This function is usable when non-MessagePack message follows after MessagePack message. </p>
</div>
</div>
<a id="a03d7d745c9e677c555ad2fc7497eaabc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03d7d745c9e677c555ad2fc7497eaabc">&#9670;&nbsp;</a></span>release_zone()</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="classmsgpack_1_1zone.html">msgpack::zone</a> * msgpack::unpacker::release_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>for backward compatibility </p>
<p class="reference">References <a class="el" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>, <a class="el" href="classmsgpack_1_1detail_1_1unpack__user.html#ab066fd31f90eb168b3d0416112c35786">msgpack::detail::unpack_user::set_zone()</a>, and <a class="el" href="classmsgpack_1_1detail_1_1context.html#ac74485be61ea7a98565f1d496818eab1">msgpack::detail::context&lt; VisitorHolder &gt;::user()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#a0c5635fe757eb3b6dc229e343360e5a6">next()</a>.</p>
</div>
</div>
<a id="a23e66e34461f979f3df08d63662fad28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23e66e34461f979f3df08d63662fad28">&#9670;&nbsp;</a></span>remove_nonparsed_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::unpacker::remove_nonparsed_buffer </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>Remove nonparsed buffer and reset the current position as a new start point. </p>
<p>This function is usable when non-MessagePack message follows after MessagePack message. </p>
</div>
</div>
<a id="a09c1f8d79b01ee69824c47c32665da26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09c1f8d79b01ee69824c47c32665da26">&#9670;&nbsp;</a></span>reserve_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::unpacker::reserve_buffer </td>
<td>(</td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>size</em> = <code><a class="el" href="v1_2unpack__decl_8hpp.html#a4387f358acd5455b09dedd1d1bb6ea0e">MSGPACK_UNPACKER_RESERVE_SIZE</a></code></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>Reserve a buffer memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The size of allocating memory.</td></tr>
</table>
</dd>
</dl>
<p>After returning this function, <a class="el" href="classmsgpack_1_1unpacker.html#adbed521398254480fee682f2ac23891d" title="Get buffer capacity.">buffer_capacity()</a> returns at least 'size'. See: <a href="https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer">https://github.com/msgpack/msgpack-c/wiki/v1_1_cpp_unpacker#msgpack-controls-a-buffer</a> </p>
<p class="reference">References <a class="el" href="namespacemsgpack_1_1type.html#a7a061773204f4469948f1e39097da648">msgpack::type::size()</a>.</p>
</div>
</div>
<a id="ad0095eaf0945754f209b7ca77805790a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0095eaf0945754f209b7ca77805790a">&#9670;&nbsp;</a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::unpacker::reset </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>for backward compatibility </p>
<p class="reference">References <a class="el" href="classmsgpack_1_1detail_1_1context.html#ae0d157b928a8ed6d30115e6d7eed4913">msgpack::detail::context&lt; VisitorHolder &gt;::init()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1unpacker.html#a0c5635fe757eb3b6dc229e343360e5a6">next()</a>.</p>
</div>
</div>
<a id="a0eb7d17a7d7962f8871a2ef8f2414e1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0eb7d17a7d7962f8871a2ef8f2414e1e">&#9670;&nbsp;</a></span>reset_zone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::unpacker::reset_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>for backward compatibility </p>
</div>
</div>
<a id="addac24de23663926c143992eb61df9af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addac24de23663926c143992eb61df9af">&#9670;&nbsp;</a></span>skip_nonparsed_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::unpacker::skip_nonparsed_buffer </td>
<td>(</td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>size</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>Skip the specified size of non-parsed buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>to skip</td></tr>
</table>
</dd>
</dl>
<p>Note that the &lsquo;size&rsquo; argument must be smaller than <a class="el" href="classmsgpack_1_1unpacker.html#a68279f3a1cfa5a26aefb62966cb8b907" title="Get the size of the buffer that is not parsed.">nonparsed_size()</a>. This function is usable when non-MessagePack message follows after MessagePack message. </p>
<p class="reference">References <a class="el" href="namespacemsgpack_1_1type.html#a7a061773204f4469948f1e39097da648">msgpack::type::size()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>msgpack/v1/<a class="el" href="v1_2unpack_8hpp_source.html">unpack.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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>
Reference in New Issue View Git Blame Copy Permalink