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_1vrefbuffer.html
Takatoshi Kondo 8b5a2ebe8c Updated doc to 4.0.2
2021-08-31 15:12:16 +09:00

454 lines
20 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::vrefbuffer 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_1vrefbuffer.html">vrefbuffer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmsgpack_1_1vrefbuffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">msgpack::vrefbuffer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="v1_2vrefbuffer_8hpp_source.html">vrefbuffer.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:a7dc392c507a2ce9e718461de8e9818d0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#a7dc392c507a2ce9e718461de8e9818d0">vrefbuffer</a> (size_t ref_size=<a class="el" href="v1_2vrefbuffer__decl_8hpp.html#a9a0211d4300690d0c5426f3e79c0ab94">MSGPACK_VREFBUFFER_REF_SIZE</a>, size_t chunk_size=<a class="el" href="v1_2vrefbuffer__decl_8hpp.html#a5128243b5f2fb0bb16a660a9c28cbe96">MSGPACK_VREFBUFFER_CHUNK_SIZE</a>)</td></tr>
<tr class="separator:a7dc392c507a2ce9e718461de8e9818d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ad64711d5a4c5bd84369efa25be37e4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#a1ad64711d5a4c5bd84369efa25be37e4">~vrefbuffer</a> ()</td></tr>
<tr class="separator:a1ad64711d5a4c5bd84369efa25be37e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d0a6336e3196213b8ac7b2f86844144"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#a5d0a6336e3196213b8ac7b2f86844144">write</a> (const char *buf, size_t len)</td></tr>
<tr class="separator:a5d0a6336e3196213b8ac7b2f86844144"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab07fa8e7df4bd499e6ac15fb488dfb57"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#ab07fa8e7df4bd499e6ac15fb488dfb57">append_ref</a> (const char *buf, size_t len)</td></tr>
<tr class="separator:ab07fa8e7df4bd499e6ac15fb488dfb57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada665077a545755599906eeb03191bf0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#ada665077a545755599906eeb03191bf0">append_copy</a> (const char *buf, size_t len)</td></tr>
<tr class="separator:ada665077a545755599906eeb03191bf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdf92a5e17d4a070345e3b5f92ff936a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structmsgpack_1_1iovec.html">iovec</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#acdf92a5e17d4a070345e3b5f92ff936a">vector</a> () const</td></tr>
<tr class="separator:acdf92a5e17d4a070345e3b5f92ff936a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad28002d12ac554478aad61f3ccf6e875"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#ad28002d12ac554478aad61f3ccf6e875">vector_size</a> () const</td></tr>
<tr class="separator:ad28002d12ac554478aad61f3ccf6e875"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab97c7ed19820779400c7cb5041cee106"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#ab97c7ed19820779400c7cb5041cee106">migrate</a> (<a class="el" href="classmsgpack_1_1vrefbuffer.html">vrefbuffer</a> *to)</td></tr>
<tr class="separator:ab97c7ed19820779400c7cb5041cee106"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a91d4b145a1a80244f7a824f944395a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#a4a91d4b145a1a80244f7a824f944395a">clear</a> ()</td></tr>
<tr class="separator:a4a91d4b145a1a80244f7a824f944395a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07cd0c806b6abaac115018ecd11e814f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#a07cd0c806b6abaac115018ecd11e814f">vrefbuffer</a> (const <a class="el" href="classmsgpack_1_1vrefbuffer.html">vrefbuffer</a> &amp;)=delete</td></tr>
<tr class="separator:a07cd0c806b6abaac115018ecd11e814f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c2f7653c92f4972d6fe4c5720dcc961"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmsgpack_1_1vrefbuffer.html">vrefbuffer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1vrefbuffer.html#a6c2f7653c92f4972d6fe4c5720dcc961">operator=</a> (const <a class="el" href="classmsgpack_1_1vrefbuffer.html">vrefbuffer</a> &amp;)=delete</td></tr>
<tr class="separator:a6c2f7653c92f4972d6fe4c5720dcc961"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7dc392c507a2ce9e718461de8e9818d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dc392c507a2ce9e718461de8e9818d0">&#9670;&nbsp;</a></span>vrefbuffer() <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::vrefbuffer::vrefbuffer </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>ref_size</em> = <code><a class="el" href="v1_2vrefbuffer__decl_8hpp.html#a9a0211d4300690d0c5426f3e79c0ab94">MSGPACK_VREFBUFFER_REF_SIZE</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>chunk_size</em> = <code><a class="el" href="v1_2vrefbuffer__decl_8hpp.html#a5128243b5f2fb0bb16a660a9c28cbe96">MSGPACK_VREFBUFFER_CHUNK_SIZE</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 class="reference">References <a class="el" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>.</p>
</div>
</div>
<a id="a1ad64711d5a4c5bd84369efa25be37e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ad64711d5a4c5bd84369efa25be37e4">&#9670;&nbsp;</a></span>~vrefbuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">msgpack::vrefbuffer::~vrefbuffer </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">
</div>
</div>
<a id="a07cd0c806b6abaac115018ecd11e814f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07cd0c806b6abaac115018ecd11e814f">&#9670;&nbsp;</a></span>vrefbuffer() <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::vrefbuffer::vrefbuffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmsgpack_1_1vrefbuffer.html">vrefbuffer</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ada665077a545755599906eeb03191bf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada665077a545755599906eeb03191bf0">&#9670;&nbsp;</a></span>append_copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::vrefbuffer::append_copy </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>
</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_1vrefbuffer.html#ab07fa8e7df4bd499e6ac15fb488dfb57">append_ref()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1vrefbuffer.html#a5d0a6336e3196213b8ac7b2f86844144">write()</a>.</p>
</div>
</div>
<a id="ab07fa8e7df4bd499e6ac15fb488dfb57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab07fa8e7df4bd499e6ac15fb488dfb57">&#9670;&nbsp;</a></span>append_ref()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::vrefbuffer::append_ref </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>
</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="structmsgpack_1_1iovec.html#ab2fc94b749ae2c1e7e7a57d63093c32a">msgpack::iovec::iov_base</a>, and <a class="el" href="structmsgpack_1_1iovec.html#a32aa38d4a1a8071f3bc04b87462e1691">msgpack::iovec::iov_len</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1vrefbuffer.html#ada665077a545755599906eeb03191bf0">append_copy()</a>, and <a class="el" href="classmsgpack_1_1vrefbuffer.html#a5d0a6336e3196213b8ac7b2f86844144">write()</a>.</p>
</div>
</div>
<a id="a4a91d4b145a1a80244f7a824f944395a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a91d4b145a1a80244f7a824f944395a">&#9670;&nbsp;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::vrefbuffer::clear </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="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>.</p>
</div>
</div>
<a id="ab97c7ed19820779400c7cb5041cee106"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab97c7ed19820779400c7cb5041cee106">&#9670;&nbsp;</a></span>migrate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::vrefbuffer::migrate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmsgpack_1_1vrefbuffer.html">vrefbuffer</a> *&#160;</td>
<td class="paramname"><em>to</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="a6c2f7653c92f4972d6fe4c5720dcc961"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c2f7653c92f4972d6fe4c5720dcc961">&#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_1vrefbuffer.html">vrefbuffer</a>&amp; msgpack::vrefbuffer::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmsgpack_1_1vrefbuffer.html">vrefbuffer</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="acdf92a5e17d4a070345e3b5f92ff936a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdf92a5e17d4a070345e3b5f92ff936a">&#9670;&nbsp;</a></span>vector()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structmsgpack_1_1iovec.html">iovec</a>* msgpack::vrefbuffer::vector </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">
</div>
</div>
<a id="ad28002d12ac554478aad61f3ccf6e875"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad28002d12ac554478aad61f3ccf6e875">&#9670;&nbsp;</a></span>vector_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t msgpack::vrefbuffer::vector_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">
</div>
</div>
<a id="a5d0a6336e3196213b8ac7b2f86844144"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d0a6336e3196213b8ac7b2f86844144">&#9670;&nbsp;</a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void msgpack::vrefbuffer::write </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>
</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_1vrefbuffer.html#ada665077a545755599906eeb03191bf0">append_copy()</a>, and <a class="el" href="classmsgpack_1_1vrefbuffer.html#ab07fa8e7df4bd499e6ac15fb488dfb57">append_ref()</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_2vrefbuffer_8hpp_source.html">vrefbuffer.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