mirror of
https://github.com/msgpack/msgpack-c.git
synced 2025-04-20 16:03:36 +02:00
286 lines
18 KiB
HTML
286 lines
18 KiB
HTML
<!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: Dynamically typed object</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> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Dynamically typed object<div class="ingroups"><a class="el" href="group__msgpack.html">MessagePack C</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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmsgpack__object__array.html">msgpack_object_array</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmsgpack__object__map.html">msgpack_object_map</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmsgpack__object__str.html">msgpack_object_str</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmsgpack__object__bin.html">msgpack_object_bin</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmsgpack__object__ext.html">msgpack_object_ext</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="unionmsgpack__object__union.html">msgpack_object_union</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmsgpack__object.html">msgpack_object</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmsgpack__object__kv.html">msgpack_object_kv</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:gaad55f642723e043d65f3683ef33ea4f6"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmsgpack__object.html">msgpack_object</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__object.html#gaad55f642723e043d65f3683ef33ea4f6">msgpack_object</a></td></tr>
|
|
<tr class="separator:gaad55f642723e043d65f3683ef33ea4f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaacf3b266d05287b1d3d5ab4b5fc9b698"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmsgpack__object__kv.html">msgpack_object_kv</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__object.html#gaacf3b266d05287b1d3d5ab4b5fc9b698">msgpack_object_kv</a></td></tr>
|
|
<tr class="separator:gaacf3b266d05287b1d3d5ab4b5fc9b698"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gaa20b0fc1786fd5c419a46fd0a1e66feb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__object.html#gaa20b0fc1786fd5c419a46fd0a1e66feb">msgpack_object_type</a> { <br />
|
|
  <a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66febad11369291e59b4a571e63669fa5a8a56">MSGPACK_OBJECT_NIL</a> = 0x00,
|
|
<a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66feba9343ae5e6cffd2f07d947a53ff22bd4c">MSGPACK_OBJECT_BOOLEAN</a> = 0x01,
|
|
<a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66febad8c6e444a967cfc924602dc47367060a">MSGPACK_OBJECT_POSITIVE_INTEGER</a> = 0x02,
|
|
<a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66feba9602051847c32b4569a4a8cea5feb1a6">MSGPACK_OBJECT_NEGATIVE_INTEGER</a> = 0x03,
|
|
<br />
|
|
  <a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66febac3cdc217d749a928f2fed26584d27871">MSGPACK_OBJECT_FLOAT32</a> = 0x0a,
|
|
<a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66feba417943f73720c8403cb79cab0e200e1c">MSGPACK_OBJECT_FLOAT64</a> = 0x04,
|
|
<a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66feba6d4ba8da5f7bad63294a78aa4f439e93">MSGPACK_OBJECT_FLOAT</a> = 0x04,
|
|
<a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66feba11f383263bef6df1c7c166c73615958c">MSGPACK_OBJECT_STR</a> = 0x05,
|
|
<br />
|
|
  <a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66febafc416bc9c0691130d8c023aafa9c90cd">MSGPACK_OBJECT_ARRAY</a> = 0x06,
|
|
<a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66febafc73c16c66bb92cc4cc3c5244de53501">MSGPACK_OBJECT_MAP</a> = 0x07,
|
|
<a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66feba203bba65f9fc2207cfd8db39cd2228e3">MSGPACK_OBJECT_BIN</a> = 0x08,
|
|
<a class="el" href="group__msgpack__object.html#ggaa20b0fc1786fd5c419a46fd0a1e66febafc6dfdb32227bf26f453d53b66d651f5">MSGPACK_OBJECT_EXT</a> = 0x09
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:gaa20b0fc1786fd5c419a46fd0a1e66feb"><td class="memSeparator" colspan="2"> </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:ga986a053807bc9ae024f4cbe114aa37ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__object.html#ga986a053807bc9ae024f4cbe114aa37ea">msgpack_object_print</a> (FILE *out, <a class="el" href="structmsgpack__object.html">msgpack_object</a> o)</td></tr>
|
|
<tr class="separator:ga986a053807bc9ae024f4cbe114aa37ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadd1d6a6b344f027415a7d6931f5b3074"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__object.html#gadd1d6a6b344f027415a7d6931f5b3074">msgpack_object_print_buffer</a> (char *buffer, size_t buffer_size, <a class="el" href="structmsgpack__object.html">msgpack_object</a> o)</td></tr>
|
|
<tr class="separator:gadd1d6a6b344f027415a7d6931f5b3074"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gadde045d056fee5f875789403045ce1f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sysdep_8h.html#ad61f64307661edacf275ed1e1995c919">MSGPACK_DLLEXPORT</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__msgpack__object.html#gadde045d056fee5f875789403045ce1f6">msgpack_object_equal</a> (const <a class="el" href="structmsgpack__object.html">msgpack_object</a> x, const <a class="el" href="structmsgpack__object.html">msgpack_object</a> y)</td></tr>
|
|
<tr class="separator:gadde045d056fee5f875789403045ce1f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="gaad55f642723e043d65f3683ef33ea4f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaad55f642723e043d65f3683ef33ea4f6">◆ </a></span>msgpack_object</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structmsgpack__object.html">msgpack_object</a> <a class="el" href="structmsgpack__object.html">msgpack_object</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaacf3b266d05287b1d3d5ab4b5fc9b698"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaacf3b266d05287b1d3d5ab4b5fc9b698">◆ </a></span>msgpack_object_kv</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct <a class="el" href="structmsgpack__object__kv.html">msgpack_object_kv</a> <a class="el" href="structmsgpack__object__kv.html">msgpack_object_kv</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="gaa20b0fc1786fd5c419a46fd0a1e66feb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaa20b0fc1786fd5c419a46fd0a1e66feb">◆ </a></span>msgpack_object_type</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__msgpack__object.html#gaa20b0fc1786fd5c419a46fd0a1e66feb">msgpack_object_type</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66febad11369291e59b4a571e63669fa5a8a56"></a>MSGPACK_OBJECT_NIL </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66feba9343ae5e6cffd2f07d947a53ff22bd4c"></a>MSGPACK_OBJECT_BOOLEAN </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66febad8c6e444a967cfc924602dc47367060a"></a>MSGPACK_OBJECT_POSITIVE_INTEGER </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66feba9602051847c32b4569a4a8cea5feb1a6"></a>MSGPACK_OBJECT_NEGATIVE_INTEGER </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66febac3cdc217d749a928f2fed26584d27871"></a>MSGPACK_OBJECT_FLOAT32 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66feba417943f73720c8403cb79cab0e200e1c"></a>MSGPACK_OBJECT_FLOAT64 </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66feba6d4ba8da5f7bad63294a78aa4f439e93"></a>MSGPACK_OBJECT_FLOAT </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66feba11f383263bef6df1c7c166c73615958c"></a>MSGPACK_OBJECT_STR </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66febafc416bc9c0691130d8c023aafa9c90cd"></a>MSGPACK_OBJECT_ARRAY </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66febafc73c16c66bb92cc4cc3c5244de53501"></a>MSGPACK_OBJECT_MAP </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66feba203bba65f9fc2207cfd8db39cd2228e3"></a>MSGPACK_OBJECT_BIN </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="ggaa20b0fc1786fd5c419a46fd0a1e66febafc6dfdb32227bf26f453d53b66d651f5"></a>MSGPACK_OBJECT_EXT </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gadde045d056fee5f875789403045ce1f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadde045d056fee5f875789403045ce1f6">◆ </a></span>msgpack_object_equal()</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_object_equal </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structmsgpack__object.html">msgpack_object</a> </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structmsgpack__object.html">msgpack_object</a> </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga986a053807bc9ae024f4cbe114aa37ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga986a053807bc9ae024f4cbe114aa37ea">◆ </a></span>msgpack_object_print()</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_object_print </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FILE * </td>
|
|
<td class="paramname"><em>out</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structmsgpack__object.html">msgpack_object</a> </td>
|
|
<td class="paramname"><em>o</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gadd1d6a6b344f027415a7d6931f5b3074"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gadd1d6a6b344f027415a7d6931f5b3074">◆ </a></span>msgpack_object_print_buffer()</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_object_print_buffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>buffer_size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structmsgpack__object.html">msgpack_object</a> </td>
|
|
<td class="paramname"><em>o</em> </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  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|