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

393 lines
16 KiB
HTML
Raw 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::zbuffer 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_1zbuffer.html">zbuffer</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_1zbuffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">msgpack::zbuffer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="v1_2zbuffer_8hpp_source.html">zbuffer.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:a70c3900c09c761c02b8e15fe2c0f5e35"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#a70c3900c09c761c02b8e15fe2c0f5e35">zbuffer</a> (int level=Z_DEFAULT_COMPRESSION, size_t init_size=<a class="el" href="v1_2zbuffer__decl_8hpp.html#af6d2b64cf59d1342f45a45ed01f428dd">MSGPACK_ZBUFFER_INIT_SIZE</a>)</td></tr>
<tr class="separator:a70c3900c09c761c02b8e15fe2c0f5e35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f0c22d40f53cfde0ce4aa3c4904e9fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#a8f0c22d40f53cfde0ce4aa3c4904e9fd">~zbuffer</a> ()</td></tr>
<tr class="separator:a8f0c22d40f53cfde0ce4aa3c4904e9fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa61d128f327e1674162d4d5ab09bca95"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#aa61d128f327e1674162d4d5ab09bca95">write</a> (const char *buf, size_t len)</td></tr>
<tr class="separator:aa61d128f327e1674162d4d5ab09bca95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35004619ce5e84a746a1ff49591e8f08"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#a35004619ce5e84a746a1ff49591e8f08">flush</a> ()</td></tr>
<tr class="separator:a35004619ce5e84a746a1ff49591e8f08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b000bcea573512cb6bab32f29c0794d"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#a8b000bcea573512cb6bab32f29c0794d">data</a> ()</td></tr>
<tr class="separator:a8b000bcea573512cb6bab32f29c0794d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d3dd3aeefe2747573a52a5c60d4590e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#a8d3dd3aeefe2747573a52a5c60d4590e">data</a> () const</td></tr>
<tr class="separator:a8d3dd3aeefe2747573a52a5c60d4590e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a6697c3354845791fe469a3bb1669a8"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#a0a6697c3354845791fe469a3bb1669a8">size</a> () const</td></tr>
<tr class="separator:a0a6697c3354845791fe469a3bb1669a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af30370f06a0bc06d3184b9f351e25c43"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#af30370f06a0bc06d3184b9f351e25c43">reset</a> ()</td></tr>
<tr class="separator:af30370f06a0bc06d3184b9f351e25c43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2ae6dcc40b29f862190a34b2d48fd50"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#ae2ae6dcc40b29f862190a34b2d48fd50">reset_buffer</a> ()</td></tr>
<tr class="separator:ae2ae6dcc40b29f862190a34b2d48fd50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2b5925138fabc1b896774f13aeb9eab"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1zbuffer.html#ab2b5925138fabc1b896774f13aeb9eab">release_buffer</a> ()</td></tr>
<tr class="separator:ab2b5925138fabc1b896774f13aeb9eab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a70c3900c09c761c02b8e15fe2c0f5e35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70c3900c09c761c02b8e15fe2c0f5e35">&#9670;&nbsp;</a></span>zbuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">msgpack::zbuffer::zbuffer </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>level</em> = <code>Z_DEFAULT_COMPRESSION</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>init_size</em> = <code><a class="el" href="v1_2zbuffer__decl_8hpp.html#af6d2b64cf59d1342f45a45ed01f428dd">MSGPACK_ZBUFFER_INIT_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">
</div>
</div>
<a id="a8f0c22d40f53cfde0ce4aa3c4904e9fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f0c22d40f53cfde0ce4aa3c4904e9fd">&#9670;&nbsp;</a></span>~zbuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">msgpack::zbuffer::~zbuffer </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>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8b000bcea573512cb6bab32f29c0794d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b000bcea573512cb6bab32f29c0794d">&#9670;&nbsp;</a></span>data() <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">char* msgpack::zbuffer::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">
</div>
</div>
<a id="a8d3dd3aeefe2747573a52a5c60d4590e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d3dd3aeefe2747573a52a5c60d4590e">&#9670;&nbsp;</a></span>data() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char* msgpack::zbuffer::data </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="a35004619ce5e84a746a1ff49591e8f08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35004619ce5e84a746a1ff49591e8f08">&#9670;&nbsp;</a></span>flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char* msgpack::zbuffer::flush </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="ab2b5925138fabc1b896774f13aeb9eab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2b5925138fabc1b896774f13aeb9eab">&#9670;&nbsp;</a></span>release_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::zbuffer::release_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 class="reference">References <a class="el" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>.</p>
</div>
</div>
<a id="af30370f06a0bc06d3184b9f351e25c43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af30370f06a0bc06d3184b9f351e25c43">&#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::zbuffer::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 class="reference">References <a class="el" href="classmsgpack_1_1zbuffer.html#ae2ae6dcc40b29f862190a34b2d48fd50">reset_buffer()</a>.</p>
</div>
</div>
<a id="ae2ae6dcc40b29f862190a34b2d48fd50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2ae6dcc40b29f862190a34b2d48fd50">&#9670;&nbsp;</a></span>reset_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::zbuffer::reset_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 class="reference">Referenced by <a class="el" href="classmsgpack_1_1zbuffer.html#af30370f06a0bc06d3184b9f351e25c43">reset()</a>.</p>
</div>
</div>
<a id="a0a6697c3354845791fe469a3bb1669a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a6697c3354845791fe469a3bb1669a8">&#9670;&nbsp;</a></span>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::zbuffer::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="aa61d128f327e1674162d4d5ab09bca95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa61d128f327e1674162d4d5ab09bca95">&#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::zbuffer::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="v1_2zbuffer__decl_8hpp.html#a9bb090017db312b9d77ff522ff2728fc">MSGPACK_ZBUFFER_RESERVE_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_2zbuffer_8hpp_source.html">zbuffer.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