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

358 lines
19 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: Vectored Referencing buffer</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">Vectored Referencing buffer<div class="ingroups"><a class="el" href="group__msgpack.html">MessagePack C</a> &raquo; <a class="el" href="group__msgpack__buffer.html">Buffers</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__vrefbuffer__inner__buffer.html">msgpack_vrefbuffer_inner_buffer</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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__vrefbuffer.html">msgpack_vrefbuffer</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:ga9a0211d4300690d0c5426f3e79c0ab94"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__vrefbuffer.html#ga9a0211d4300690d0c5426f3e79c0ab94">MSGPACK_VREFBUFFER_REF_SIZE</a>&#160;&#160;&#160;32</td></tr>
<tr class="separator:ga9a0211d4300690d0c5426f3e79c0ab94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5128243b5f2fb0bb16a660a9c28cbe96"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__vrefbuffer.html#ga5128243b5f2fb0bb16a660a9c28cbe96">MSGPACK_VREFBUFFER_CHUNK_SIZE</a>&#160;&#160;&#160;8192</td></tr>
<tr class="separator:ga5128243b5f2fb0bb16a660a9c28cbe96"><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:gab6347d30894496a84079d4d4a0159dd8"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__msgpack__vrefbuffer.html#gab6347d30894496a84079d4d4a0159dd8">msgpack_vrefbuffer_chunk</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__vrefbuffer.html#gab6347d30894496a84079d4d4a0159dd8">msgpack_vrefbuffer_chunk</a></td></tr>
<tr class="separator:gab6347d30894496a84079d4d4a0159dd8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga229f037d9182b790ab2ede54c299f36b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmsgpack__vrefbuffer__inner__buffer.html">msgpack_vrefbuffer_inner_buffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__vrefbuffer.html#ga229f037d9182b790ab2ede54c299f36b">msgpack_vrefbuffer_inner_buffer</a></td></tr>
<tr class="separator:ga229f037d9182b790ab2ede54c299f36b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaae7a78a88265d5fbc94f34b1c102074a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__vrefbuffer.html#gaae7a78a88265d5fbc94f34b1c102074a">msgpack_vrefbuffer</a></td></tr>
<tr class="separator:gaae7a78a88265d5fbc94f34b1c102074a"><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:gae17972a3f9c37b33c4ffbf27fde4f9c8"><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__vrefbuffer.html#gae17972a3f9c37b33c4ffbf27fde4f9c8">msgpack_vrefbuffer_init</a> (<a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *vbuf, size_t ref_size, size_t chunk_size)</td></tr>
<tr class="separator:gae17972a3f9c37b33c4ffbf27fde4f9c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga436dff3c5d5cc6a884307271b4fe68b3"><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__vrefbuffer.html#ga436dff3c5d5cc6a884307271b4fe68b3">msgpack_vrefbuffer_destroy</a> (<a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *vbuf)</td></tr>
<tr class="separator:ga436dff3c5d5cc6a884307271b4fe68b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2139fe853eeaef7b582ba37febd39d1d"><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__vrefbuffer.html#ga2139fe853eeaef7b582ba37febd39d1d">msgpack_vrefbuffer_append_copy</a> (<a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *vbuf, const char *buf, size_t <a class="el" href="unpack__template_8h.html#ac16e956eac9f5c3180afa8e80d4f098c">len</a>)</td></tr>
<tr class="separator:ga2139fe853eeaef7b582ba37febd39d1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabdeefd24685b7f808497e37b316e567b"><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__vrefbuffer.html#gabdeefd24685b7f808497e37b316e567b">msgpack_vrefbuffer_append_ref</a> (<a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *vbuf, const char *buf, size_t <a class="el" href="unpack__template_8h.html#ac16e956eac9f5c3180afa8e80d4f098c">len</a>)</td></tr>
<tr class="separator:gabdeefd24685b7f808497e37b316e567b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga06240f21dfbdd035d452001d467c461b"><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__vrefbuffer.html#ga06240f21dfbdd035d452001d467c461b">msgpack_vrefbuffer_migrate</a> (<a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *vbuf, <a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *to)</td></tr>
<tr class="separator:ga06240f21dfbdd035d452001d467c461b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa25f4ab21cd48155ce3ac378256cc1ab"><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__vrefbuffer.html#gaa25f4ab21cd48155ce3ac378256cc1ab">msgpack_vrefbuffer_clear</a> (<a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *vref)</td></tr>
<tr class="separator:gaa25f4ab21cd48155ce3ac378256cc1ab"><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="ga5128243b5f2fb0bb16a660a9c28cbe96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5128243b5f2fb0bb16a660a9c28cbe96">&#9670;&nbsp;</a></span>MSGPACK_VREFBUFFER_CHUNK_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSGPACK_VREFBUFFER_CHUNK_SIZE&#160;&#160;&#160;8192</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga9a0211d4300690d0c5426f3e79c0ab94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a0211d4300690d0c5426f3e79c0ab94">&#9670;&nbsp;</a></span>MSGPACK_VREFBUFFER_REF_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MSGPACK_VREFBUFFER_REF_SIZE&#160;&#160;&#160;32</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gaae7a78a88265d5fbc94f34b1c102074a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae7a78a88265d5fbc94f34b1c102074a">&#9670;&nbsp;</a></span>msgpack_vrefbuffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> <a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gab6347d30894496a84079d4d4a0159dd8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab6347d30894496a84079d4d4a0159dd8">&#9670;&nbsp;</a></span>msgpack_vrefbuffer_chunk</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__msgpack__vrefbuffer.html#gab6347d30894496a84079d4d4a0159dd8">msgpack_vrefbuffer_chunk</a> <a class="el" href="group__msgpack__vrefbuffer.html#gab6347d30894496a84079d4d4a0159dd8">msgpack_vrefbuffer_chunk</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga229f037d9182b790ab2ede54c299f36b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga229f037d9182b790ab2ede54c299f36b">&#9670;&nbsp;</a></span>msgpack_vrefbuffer_inner_buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structmsgpack__vrefbuffer__inner__buffer.html">msgpack_vrefbuffer_inner_buffer</a> <a class="el" href="structmsgpack__vrefbuffer__inner__buffer.html">msgpack_vrefbuffer_inner_buffer</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga2139fe853eeaef7b582ba37febd39d1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2139fe853eeaef7b582ba37febd39d1d">&#9670;&nbsp;</a></span>msgpack_vrefbuffer_append_copy()</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_vrefbuffer_append_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *&#160;</td>
<td class="paramname"><em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gabdeefd24685b7f808497e37b316e567b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabdeefd24685b7f808497e37b316e567b">&#9670;&nbsp;</a></span>msgpack_vrefbuffer_append_ref()</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_vrefbuffer_append_ref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *&#160;</td>
<td class="paramname"><em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>len</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gaa25f4ab21cd48155ce3ac378256cc1ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa25f4ab21cd48155ce3ac378256cc1ab">&#9670;&nbsp;</a></span>msgpack_vrefbuffer_clear()</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_vrefbuffer_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *&#160;</td>
<td class="paramname"><em>vref</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga436dff3c5d5cc6a884307271b4fe68b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga436dff3c5d5cc6a884307271b4fe68b3">&#9670;&nbsp;</a></span>msgpack_vrefbuffer_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_vrefbuffer_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *&#160;</td>
<td class="paramname"><em>vbuf</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="gae17972a3f9c37b33c4ffbf27fde4f9c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae17972a3f9c37b33c4ffbf27fde4f9c8">&#9670;&nbsp;</a></span>msgpack_vrefbuffer_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_vrefbuffer_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *&#160;</td>
<td class="paramname"><em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>ref_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>chunk_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ga06240f21dfbdd035d452001d467c461b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga06240f21dfbdd035d452001d467c461b">&#9670;&nbsp;</a></span>msgpack_vrefbuffer_migrate()</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_vrefbuffer_migrate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *&#160;</td>
<td class="paramname"><em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structmsgpack__vrefbuffer.html">msgpack_vrefbuffer</a> *&#160;</td>
<td class="paramname"><em>to</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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