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

436 lines
26 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: Streaming deserializer</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>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Streaming deserializer<div class="ingroups"><a class="el" href="group__msgpack.html">MessagePack C</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga425e3370ec89bc0a8ebc645d8d7f3d7f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga425e3370ec89bc0a8ebc645d8d7f3d7f">MSGPACK_UNPACKER_INIT_BUFFER_SIZE</a>&#160;&#160;&#160;(64*1024)</td></tr>
<tr class="separator:ga425e3370ec89bc0a8ebc645d8d7f3d7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4387f358acd5455b09dedd1d1bb6ea0e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga4387f358acd5455b09dedd1d1bb6ea0e">MSGPACK_UNPACKER_RESERVE_SIZE</a>&#160;&#160;&#160;(32*1024)</td></tr>
<tr class="separator:ga4387f358acd5455b09dedd1d1bb6ea0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga0a41728b5a474c260363646ef7fb9f17"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga0a41728b5a474c260363646ef7fb9f17">msgpack_unpacker</a></td></tr>
<tr class="separator:ga0a41728b5a474c260363646ef7fb9f17"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabe379b2ff39a7cf7d1da7d74217bf857"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#gabe379b2ff39a7cf7d1da7d74217bf857">msgpack_unpacker_init</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac, size_t initial_buffer_size)</td></tr>
<tr class="memdesc:gabe379b2ff39a7cf7d1da7d74217bf857"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a streaming deserializer. <a href="#gabe379b2ff39a7cf7d1da7d74217bf857">More...</a><br /></td></tr>
<tr class="separator:gabe379b2ff39a7cf7d1da7d74217bf857"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga350a0f638cdc6817b90ff669cd278f3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga350a0f638cdc6817b90ff669cd278f3b">msgpack_unpacker_destroy</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac)</td></tr>
<tr class="memdesc:ga350a0f638cdc6817b90ff669cd278f3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys a streaming deserializer initialized by <a class="el" href="group__msgpack__unpacker.html#gabe379b2ff39a7cf7d1da7d74217bf857" title="Initializes a streaming deserializer. ">msgpack_unpacker_init(msgpack_unpacker*, size_t)</a>. <a href="#ga350a0f638cdc6817b90ff669cd278f3b">More...</a><br /></td></tr>
<tr class="separator:ga350a0f638cdc6817b90ff669cd278f3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6066395c3a27f95336fd7707797219f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga6066395c3a27f95336fd7707797219f6">msgpack_unpacker_new</a> (size_t initial_buffer_size)</td></tr>
<tr class="memdesc:ga6066395c3a27f95336fd7707797219f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a streaming deserializer. <a href="#ga6066395c3a27f95336fd7707797219f6">More...</a><br /></td></tr>
<tr class="separator:ga6066395c3a27f95336fd7707797219f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadc6af48a6ab0df812e1ca6972eb6e60d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#gadc6af48a6ab0df812e1ca6972eb6e60d">msgpack_unpacker_free</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac)</td></tr>
<tr class="memdesc:gadc6af48a6ab0df812e1ca6972eb6e60d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a streaming deserializer created by <a class="el" href="group__msgpack__unpacker.html#ga6066395c3a27f95336fd7707797219f6" title="Creates a streaming deserializer. ">msgpack_unpacker_new(size_t)</a>. <a href="#gadc6af48a6ab0df812e1ca6972eb6e60d">More...</a><br /></td></tr>
<tr class="separator:gadc6af48a6ab0df812e1ca6972eb6e60d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4507a0762172e965a78a74e6392090c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="group__msgpack__unpack.html#ga0762f1a4aaddf2935d985b22ec9d71be">msgpack_unpack_return</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga4507a0762172e965a78a74e6392090c8">msgpack_unpacker_next</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac, <a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a> *pac)</td></tr>
<tr class="memdesc:ga4507a0762172e965a78a74e6392090c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserializes one object. <a href="#ga4507a0762172e965a78a74e6392090c8">More...</a><br /></td></tr>
<tr class="separator:ga4507a0762172e965a78a74e6392090c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga03bd96675db5e11f033b3015a04914b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="group__msgpack__unpack.html#ga0762f1a4aaddf2935d985b22ec9d71be">msgpack_unpack_return</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga03bd96675db5e11f033b3015a04914b5">msgpack_unpacker_next_with_size</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac, <a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a> *result, size_t *p_bytes)</td></tr>
<tr class="memdesc:ga03bd96675db5e11f033b3015a04914b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserializes one object and set the number of parsed bytes involved. <a href="#ga03bd96675db5e11f033b3015a04914b5">More...</a><br /></td></tr>
<tr class="separator:ga03bd96675db5e11f033b3015a04914b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9ebb4276fc95fba12302b7b4f07aded3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga9ebb4276fc95fba12302b7b4f07aded3">msgpack_unpacker_execute</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac)</td></tr>
<tr class="separator:ga9ebb4276fc95fba12302b7b4f07aded3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga72b6ca9f297688af18ff6e6540223112"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="structmsgpack__object.html">msgpack_object</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga72b6ca9f297688af18ff6e6540223112">msgpack_unpacker_data</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac)</td></tr>
<tr class="separator:ga72b6ca9f297688af18ff6e6540223112"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d06d2b4454c15eb6edc3bfe8bd717d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="structmsgpack__zone.html">msgpack_zone</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga6d06d2b4454c15eb6edc3bfe8bd717d6">msgpack_unpacker_release_zone</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac)</td></tr>
<tr class="separator:ga6d06d2b4454c15eb6edc3bfe8bd717d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2eaf0eefd8df8ead231151dc758186f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga2eaf0eefd8df8ead231151dc758186f9">msgpack_unpacker_reset_zone</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac)</td></tr>
<tr class="separator:ga2eaf0eefd8df8ead231151dc758186f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8d8faef25e9863335cc235ed4a058076"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__unpacker.html#ga8d8faef25e9863335cc235ed4a058076">msgpack_unpacker_reset</a> (<a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *mpac)</td></tr>
<tr class="separator:ga8d8faef25e9863335cc235ed4a058076"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga425e3370ec89bc0a8ebc645d8d7f3d7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga425e3370ec89bc0a8ebc645d8d7f3d7f">&#9670;&nbsp;</a></span>MSGPACK_UNPACKER_INIT_BUFFER_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSGPACK_UNPACKER_INIT_BUFFER_SIZE&#160;&#160;&#160;(64*1024)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga4387f358acd5455b09dedd1d1bb6ea0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4387f358acd5455b09dedd1d1bb6ea0e">&#9670;&nbsp;</a></span>MSGPACK_UNPACKER_RESERVE_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSGPACK_UNPACKER_RESERVE_SIZE&#160;&#160;&#160;(32*1024)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga0a41728b5a474c260363646ef7fb9f17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a41728b5a474c260363646ef7fb9f17">&#9670;&nbsp;</a></span>msgpack_unpacker</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> <a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga72b6ca9f297688af18ff6e6540223112"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga72b6ca9f297688af18ff6e6540223112">&#9670;&nbsp;</a></span>msgpack_unpacker_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="structmsgpack__object.html">msgpack_object</a> msgpack_unpacker_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga350a0f638cdc6817b90ff669cd278f3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga350a0f638cdc6817b90ff669cd278f3b">&#9670;&nbsp;</a></span>msgpack_unpacker_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> void msgpack_unpacker_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys a streaming deserializer initialized by <a class="el" href="group__msgpack__unpacker.html#gabe379b2ff39a7cf7d1da7d74217bf857" title="Initializes a streaming deserializer. ">msgpack_unpacker_init(msgpack_unpacker*, size_t)</a>. </p>
</div>
</div>
<a id="ga9ebb4276fc95fba12302b7b4f07aded3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ebb4276fc95fba12302b7b4f07aded3">&#9670;&nbsp;</a></span>msgpack_unpacker_execute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> int msgpack_unpacker_execute </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gadc6af48a6ab0df812e1ca6972eb6e60d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadc6af48a6ab0df812e1ca6972eb6e60d">&#9670;&nbsp;</a></span>msgpack_unpacker_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> void msgpack_unpacker_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees a streaming deserializer created by <a class="el" href="group__msgpack__unpacker.html#ga6066395c3a27f95336fd7707797219f6" title="Creates a streaming deserializer. ">msgpack_unpacker_new(size_t)</a>. </p>
</div>
</div>
<a id="gabe379b2ff39a7cf7d1da7d74217bf857"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabe379b2ff39a7cf7d1da7d74217bf857">&#9670;&nbsp;</a></span>msgpack_unpacker_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> bool msgpack_unpacker_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>initial_buffer_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes a streaming deserializer. </p>
<p>The initialized deserializer must be destroyed by <a class="el" href="group__msgpack__unpacker.html#ga350a0f638cdc6817b90ff669cd278f3b" title="Destroys a streaming deserializer initialized by msgpack_unpacker_init(msgpack_unpacker*, size_t). ">msgpack_unpacker_destroy(msgpack_unpacker*)</a>. </p>
</div>
</div>
<a id="ga6066395c3a27f95336fd7707797219f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6066395c3a27f95336fd7707797219f6">&#9670;&nbsp;</a></span>msgpack_unpacker_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a>* msgpack_unpacker_new </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>initial_buffer_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a streaming deserializer. </p>
<p>The created deserializer must be destroyed by <a class="el" href="group__msgpack__unpacker.html#gadc6af48a6ab0df812e1ca6972eb6e60d" title="Frees a streaming deserializer created by msgpack_unpacker_new(size_t). ">msgpack_unpacker_free(msgpack_unpacker*)</a>. </p>
</div>
</div>
<a id="ga4507a0762172e965a78a74e6392090c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4507a0762172e965a78a74e6392090c8">&#9670;&nbsp;</a></span>msgpack_unpacker_next()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="group__msgpack__unpack.html#ga0762f1a4aaddf2935d985b22ec9d71be">msgpack_unpack_return</a> msgpack_unpacker_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a> *&#160;</td>
<td class="paramname"><em>pac</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deserializes one object. </p>
<p>Returns true if it successes. Otherwise false is returned. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pac</td><td>pointer to an initialized <a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga03bd96675db5e11f033b3015a04914b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03bd96675db5e11f033b3015a04914b5">&#9670;&nbsp;</a></span>msgpack_unpacker_next_with_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="group__msgpack__unpack.html#ga0762f1a4aaddf2935d985b22ec9d71be">msgpack_unpack_return</a> msgpack_unpacker_next_with_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a> *&#160;</td>
<td class="paramname"><em>result</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *&#160;</td>
<td class="paramname"><em>p_bytes</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deserializes one object and set the number of parsed bytes involved. </p>
<p>Returns true if it successes. Otherwise false is returned. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mpac</td><td>pointer to an initialized <a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> object. </td></tr>
<tr><td class="paramname">result</td><td>pointer to an initialized <a class="el" href="structmsgpack__unpacked.html">msgpack_unpacked</a> object. </td></tr>
<tr><td class="paramname">p_bytes</td><td>pointer to variable that will be set with the number of parsed bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6d06d2b4454c15eb6edc3bfe8bd717d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6d06d2b4454c15eb6edc3bfe8bd717d6">&#9670;&nbsp;</a></span>msgpack_unpacker_release_zone()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> <a class="el" href="structmsgpack__zone.html">msgpack_zone</a>* msgpack_unpacker_release_zone </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga8d8faef25e9863335cc235ed4a058076"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d8faef25e9863335cc235ed4a058076">&#9670;&nbsp;</a></span>msgpack_unpacker_reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> void msgpack_unpacker_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga2eaf0eefd8df8ead231151dc758186f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2eaf0eefd8df8ead231151dc758186f9">&#9670;&nbsp;</a></span>msgpack_unpacker_reset_zone()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> void msgpack_unpacker_reset_zone </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__unpacker.html">msgpack_unpacker</a> *&#160;</td>
<td class="paramname"><em>mpac</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</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