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

448 lines
20 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++: msgpack::sbuffer 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.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>
<!-- 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_1sbuffer.html">sbuffer</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_1sbuffer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">msgpack::sbuffer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="v1_2sbuffer_8hpp_source.html">sbuffer.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:a5626e94ce668c724247b68098a96dd92"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#a5626e94ce668c724247b68098a96dd92">sbuffer</a> (size_t initsz=<a class="el" href="v2_2sbuffer__decl_8hpp.html#ade520c7c47ad98eedfa182d236c9a4e6">MSGPACK_SBUFFER_INIT_SIZE</a>)</td></tr>
<tr class="separator:a5626e94ce668c724247b68098a96dd92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84dde020635e856e891f5a0b2855a70c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#a84dde020635e856e891f5a0b2855a70c">~sbuffer</a> ()</td></tr>
<tr class="separator:a84dde020635e856e891f5a0b2855a70c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28ae83d575fc9f815216a10d8e3f73b8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#a28ae83d575fc9f815216a10d8e3f73b8">sbuffer</a> (const <a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</a> &amp;)=delete</td></tr>
<tr class="separator:a28ae83d575fc9f815216a10d8e3f73b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44526e14f46cc6bc03ece9fb8b7ad3e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#a44526e14f46cc6bc03ece9fb8b7ad3e1">operator=</a> (const <a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</a> &amp;)=delete</td></tr>
<tr class="separator:a44526e14f46cc6bc03ece9fb8b7ad3e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a816522e0c43962bd39866bfe05cae0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#a1a816522e0c43962bd39866bfe05cae0">sbuffer</a> (<a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</a> &amp;&amp;other)</td></tr>
<tr class="separator:a1a816522e0c43962bd39866bfe05cae0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb9c69c7c16d7f8bfdcdc577e5634960"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#aeb9c69c7c16d7f8bfdcdc577e5634960">operator=</a> (<a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</a> &amp;&amp;other)</td></tr>
<tr class="separator:aeb9c69c7c16d7f8bfdcdc577e5634960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5083b6fa594de17a5cf193321a0fc15"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#af5083b6fa594de17a5cf193321a0fc15">write</a> (const char *buf, size_t len)</td></tr>
<tr class="separator:af5083b6fa594de17a5cf193321a0fc15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a766373c0acb0f208d764703f53c651d3"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#a766373c0acb0f208d764703f53c651d3">data</a> ()</td></tr>
<tr class="separator:a766373c0acb0f208d764703f53c651d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abaa172a91df1268430a5f2ebb72d3d44"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#abaa172a91df1268430a5f2ebb72d3d44">data</a> () const</td></tr>
<tr class="separator:abaa172a91df1268430a5f2ebb72d3d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc9a4eff4e2fe49142467a254057ef35"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#abc9a4eff4e2fe49142467a254057ef35">size</a> () const</td></tr>
<tr class="separator:abc9a4eff4e2fe49142467a254057ef35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ab4c730fa62efb591cfac91c3bb64eb"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#a0ab4c730fa62efb591cfac91c3bb64eb">release</a> ()</td></tr>
<tr class="separator:a0ab4c730fa62efb591cfac91c3bb64eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d18d975074116302f5329a4bf2d5892"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1sbuffer.html#a8d18d975074116302f5329a4bf2d5892">clear</a> ()</td></tr>
<tr class="separator:a8d18d975074116302f5329a4bf2d5892"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5626e94ce668c724247b68098a96dd92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5626e94ce668c724247b68098a96dd92">&#9670;&nbsp;</a></span>sbuffer() <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">msgpack::sbuffer::sbuffer </td>
<td>(</td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>initsz</em> = <code><a class="el" href="v2_2sbuffer__decl_8hpp.html#ade520c7c47ad98eedfa182d236c9a4e6">MSGPACK_SBUFFER_INIT_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 class="reference">References <a class="el" href="v1_2cpp__config__decl_8hpp.html#a68eb5e9337cb3cdcc7da1f4ab5333e26">MSGPACK_NULLPTR</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1sbuffer.html#a8d18d975074116302f5329a4bf2d5892">clear()</a>, and <a class="el" href="classmsgpack_1_1sbuffer.html#a84dde020635e856e891f5a0b2855a70c">~sbuffer()</a>.</p>
</div>
</div>
<a id="a84dde020635e856e891f5a0b2855a70c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84dde020635e856e891f5a0b2855a70c">&#9670;&nbsp;</a></span>~sbuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">msgpack::sbuffer::~sbuffer </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_1sbuffer.html#a44526e14f46cc6bc03ece9fb8b7ad3e1">operator=()</a>, and <a class="el" href="classmsgpack_1_1sbuffer.html#a5626e94ce668c724247b68098a96dd92">sbuffer()</a>.</p>
</div>
</div>
<a id="a28ae83d575fc9f815216a10d8e3f73b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28ae83d575fc9f815216a10d8e3f73b8">&#9670;&nbsp;</a></span>sbuffer() <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">msgpack::sbuffer::sbuffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</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="a1a816522e0c43962bd39866bfe05cae0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a816522e0c43962bd39866bfe05cae0">&#9670;&nbsp;</a></span>sbuffer() <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">msgpack::sbuffer::sbuffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</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>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8d18d975074116302f5329a4bf2d5892"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d18d975074116302f5329a4bf2d5892">&#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::sbuffer::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_2sbuffer__decl_8hpp.html#ade520c7c47ad98eedfa182d236c9a4e6">MSGPACK_SBUFFER_INIT_SIZE</a>, <a class="el" href="classmsgpack_1_1sbuffer.html#a44526e14f46cc6bc03ece9fb8b7ad3e1">operator=()</a>, and <a class="el" href="classmsgpack_1_1sbuffer.html#a5626e94ce668c724247b68098a96dd92">sbuffer()</a>.</p>
</div>
</div>
<a id="a766373c0acb0f208d764703f53c651d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a766373c0acb0f208d764703f53c651d3">&#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::sbuffer::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="abaa172a91df1268430a5f2ebb72d3d44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaa172a91df1268430a5f2ebb72d3d44">&#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::sbuffer::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="a44526e14f46cc6bc03ece9fb8b7ad3e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44526e14f46cc6bc03ece9fb8b7ad3e1">&#9670;&nbsp;</a></span>operator=() <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"><a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</a>&amp; msgpack::sbuffer::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</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">
<p class="reference">Referenced by <a class="el" href="classmsgpack_1_1sbuffer.html#a8d18d975074116302f5329a4bf2d5892">clear()</a>, and <a class="el" href="classmsgpack_1_1sbuffer.html#a84dde020635e856e891f5a0b2855a70c">~sbuffer()</a>.</p>
</div>
</div>
<a id="aeb9c69c7c16d7f8bfdcdc577e5634960"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb9c69c7c16d7f8bfdcdc577e5634960">&#9670;&nbsp;</a></span>operator=() <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"><a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</a>&amp; msgpack::sbuffer::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmsgpack_1_1sbuffer.html">sbuffer</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="a0ab4c730fa62efb591cfac91c3bb64eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ab4c730fa62efb591cfac91c3bb64eb">&#9670;&nbsp;</a></span>release()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char* msgpack::sbuffer::release </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="abc9a4eff4e2fe49142467a254057ef35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc9a4eff4e2fe49142467a254057ef35">&#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::sbuffer::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="af5083b6fa594de17a5cf193321a0fc15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5083b6fa594de17a5cf193321a0fc15">&#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::sbuffer::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">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/kondo/work/msgpack-c/include/msgpack/v1/<a class="el" href="v1_2sbuffer_8hpp_source.html">sbuffer.hpp</a></li>
</ul>
</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