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/c/pack_8h.html
Takatoshi Kondo 103698b38d First gh-pages commit
2016-04-03 23:53:04 +09:00

242 lines
15 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.11"/>
<title>MessagePack for C: /home/kondo/work/msgpack-c/include/msgpack/pack.h File 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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_dd2411636cfeb3780831d8d9eec9249e.html">msgpack</a></li> </ul>
</div>
</div><!-- top -->
<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">pack.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="pack__define_8h_source.html">pack_define.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="object_8h_source.html">object.h</a>&quot;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &quot;<a class="el" href="pack__template_8h_source.html">pack_template.h</a>&quot;</code><br />
</div>
<p><a href="pack_8h_source.html">Go to the source code of this file.</a></p>
<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__packer.html">msgpack_packer</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:a59e76900467a0458b31f8136eec67952"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pack_8h.html#a59e76900467a0458b31f8136eec67952">msgpack_pack_inline_func</a>(name)&#160;&#160;&#160;inline int msgpack_pack ## name</td></tr>
<tr class="separator:a59e76900467a0458b31f8136eec67952"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a514234b263ca8c8b850a538732e6b2f5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pack_8h.html#a514234b263ca8c8b850a538732e6b2f5">msgpack_pack_inline_func_cint</a>(name)&#160;&#160;&#160;inline int msgpack_pack ## name</td></tr>
<tr class="separator:a514234b263ca8c8b850a538732e6b2f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b5d9176c00475ee47c3908e1dcaf281"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pack_8h.html#a2b5d9176c00475ee47c3908e1dcaf281">msgpack_pack_inline_func_fixint</a>(name)&#160;&#160;&#160;inline int msgpack_pack_fix ## name</td></tr>
<tr class="separator:a2b5d9176c00475ee47c3908e1dcaf281"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9f19bd9ed41f19941899c8a9ae64465"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pack_8h.html#aa9f19bd9ed41f19941899c8a9ae64465">msgpack_pack_user</a>&#160;&#160;&#160;<a class="el" href="structmsgpack__packer.html">msgpack_packer</a>*</td></tr>
<tr class="separator:aa9f19bd9ed41f19941899c8a9ae64465"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ae392e5978fcd0dd576a81d622dc20f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pack_8h.html#a3ae392e5978fcd0dd576a81d622dc20f">msgpack_pack_append_buffer</a>(<a class="el" href="unpack__template_8h.html#ae37b38fee2bcd3f95af17f231df30d75">user</a>, buf, <a class="el" href="unpack__template_8h.html#ac16e956eac9f5c3180afa8e80d4f098c">len</a>)&#160;&#160;&#160;return (*(<a class="el" href="unpack__template_8h.html#ae37b38fee2bcd3f95af17f231df30d75">user</a>)-&gt;callback)((<a class="el" href="unpack__template_8h.html#ae37b38fee2bcd3f95af17f231df30d75">user</a>)-&gt;<a class="el" href="unpack__template_8h.html#a8f64897c7ccc5c13f276d1d07c4e7095">data</a>, (const char*)buf, <a class="el" href="unpack__template_8h.html#ac16e956eac9f5c3180afa8e80d4f098c">len</a>)</td></tr>
<tr class="separator:a3ae392e5978fcd0dd576a81d622dc20f"><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:ga92a554ae5ff979204b402fa73261b1ac"><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__pack.html#ga92a554ae5ff979204b402fa73261b1ac">msgpack_packer_write</a>) (void *<a class="el" href="unpack__template_8h.html#a8f64897c7ccc5c13f276d1d07c4e7095">data</a>, const char *buf, size_t <a class="el" href="unpack__template_8h.html#ac16e956eac9f5c3180afa8e80d4f098c">len</a>)</td></tr>
<tr class="separator:ga92a554ae5ff979204b402fa73261b1ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae54bc4652b1139b805d60866cc865ce9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmsgpack__packer.html">msgpack_packer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__pack.html#gae54bc4652b1139b805d60866cc865ce9">msgpack_packer</a></td></tr>
<tr class="separator:gae54bc4652b1139b805d60866cc865ce9"><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:gad606cab0cd3a670387d06a9a3bc9ab8a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__pack.html#gad606cab0cd3a670387d06a9a3bc9ab8a">msgpack_pack_object</a> (<a class="el" href="structmsgpack__packer.html">msgpack_packer</a> *pk, <a class="el" href="structmsgpack__object.html">msgpack_object</a> d)</td></tr>
<tr class="separator:gad606cab0cd3a670387d06a9a3bc9ab8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a3ae392e5978fcd0dd576a81d622dc20f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define msgpack_pack_append_buffer</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><a class="el" href="unpack__template_8h.html#ae37b38fee2bcd3f95af17f231df30d75">user</a>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">buf, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname"><a class="el" href="unpack__template_8h.html#ac16e956eac9f5c3180afa8e80d4f098c">len</a>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;return (*(<a class="el" href="unpack__template_8h.html#ae37b38fee2bcd3f95af17f231df30d75">user</a>)-&gt;callback)((<a class="el" href="unpack__template_8h.html#ae37b38fee2bcd3f95af17f231df30d75">user</a>)-&gt;<a class="el" href="unpack__template_8h.html#a8f64897c7ccc5c13f276d1d07c4e7095">data</a>, (const char*)buf, <a class="el" href="unpack__template_8h.html#ac16e956eac9f5c3180afa8e80d4f098c">len</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="pack__template_8h.html#afa96e659cffa3682e32070fff5903669">_array()</a>, <a class="el" href="pack__template_8h.html#a528b5d8968b3837450852b228c80f91c">_bin()</a>, <a class="el" href="pack__template_8h.html#a01f954bd4e4e6537342966ad11ab1d36">_bin_body()</a>, <a class="el" href="pack__template_8h.html#a22edb56a7c4e60eef878a2b627b8c84b">_double()</a>, <a class="el" href="pack__template_8h.html#a4639e08b6035e027d1b5842ca0ef6252">_ext()</a>, <a class="el" href="pack__template_8h.html#a86098394a10926d4ac183bf9f8fda32b">_ext_body()</a>, <a class="el" href="pack__template_8h.html#af18fd9cd081b7c740e70cab64c7f1d67">_false()</a>, <a class="el" href="pack__template_8h.html#ac6a2a521a5efd6eb6cf14c56c6e76e50">_float()</a>, <a class="el" href="pack__template_8h.html#a7bbe9197c4b9fc932c5da4a68ab7831c">_map()</a>, <a class="el" href="pack__template_8h.html#a172f2faf3474073f65dac7cb30c4eef7">_nil()</a>, <a class="el" href="pack__template_8h.html#a1ccdb042936a463d5a945db987081ec0">_str()</a>, <a class="el" href="pack__template_8h.html#afb44953065668698500823f9ec9c25e7">_str_body()</a>, <a class="el" href="pack__template_8h.html#aabd0bfba721ba790d2c75fe388be55e9">_true()</a>, <a class="el" href="pack__template_8h.html#a2207ecb9282069f3340e4f15fd5af215">_v4raw()</a>, and <a class="el" href="pack__template_8h.html#aeeb6976a65601488c555e9f6880636bb">_v4raw_body()</a>.</p>
</div>
</div>
<a class="anchor" id="a59e76900467a0458b31f8136eec67952"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define msgpack_pack_inline_func</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">name</td><td>)</td>
<td>&#160;&#160;&#160;inline int msgpack_pack ## name</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a514234b263ca8c8b850a538732e6b2f5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define msgpack_pack_inline_func_cint</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">name</td><td>)</td>
<td>&#160;&#160;&#160;inline int msgpack_pack ## name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="pack__template_8h.html#a49a841864a8343de2467ecbd69700b2d">_unsigned_char()</a>.</p>
</div>
</div>
<a class="anchor" id="a2b5d9176c00475ee47c3908e1dcaf281"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define msgpack_pack_inline_func_fixint</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">name</td><td>)</td>
<td>&#160;&#160;&#160;inline int msgpack_pack_fix ## name</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa9f19bd9ed41f19941899c8a9ae64465"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define msgpack_pack_user&#160;&#160;&#160;<a class="el" href="structmsgpack__packer.html">msgpack_packer</a>*</td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="pack__template_8h.html#a49a841864a8343de2467ecbd69700b2d">_unsigned_char()</a>.</p>
</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.11
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink