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

276 lines
13 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::define&lt; Type &gt; Class Template 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_1define.html">define</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmsgpack_1_1define-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">msgpack::define&lt; Type &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="v1_2object_8hpp_source.html">object.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for msgpack::define&lt; Type &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classmsgpack_1_1define__inherit__graph.png" border="0" usemap="#amsgpack_1_1define_3_01_type_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="amsgpack_1_1define_3_01_type_01_4_inherit__map" id="amsgpack_1_1define_3_01_type_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,188,107"/>
<area shape="rect" title=" " alt="" coords="71,5,122,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for msgpack::define&lt; Type &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classmsgpack_1_1define__coll__graph.png" border="0" usemap="#amsgpack_1_1define_3_01_type_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="amsgpack_1_1define_3_01_type_01_4_coll__map" id="amsgpack_1_1define_3_01_type_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="5,80,188,107"/>
<area shape="rect" title=" " alt="" coords="71,5,122,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:afaa1391b7633eb5b3343dc2d3bb4d009"><td class="memItemLeft" align="right" valign="top">typedef Type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1define.html#afaa1391b7633eb5b3343dc2d3bb4d009">msgpack_type</a></td></tr>
<tr class="separator:afaa1391b7633eb5b3343dc2d3bb4d009"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7e8a3d402dce5fb70796fa4ee6460c8"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classmsgpack_1_1define.html">define</a>&lt; Type &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1define.html#ae7e8a3d402dce5fb70796fa4ee6460c8">define_type</a></td></tr>
<tr class="separator:ae7e8a3d402dce5fb70796fa4ee6460c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a371628638adb5968001c01b466242cf7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1define.html#a371628638adb5968001c01b466242cf7">define</a> ()</td></tr>
<tr class="separator:a371628638adb5968001c01b466242cf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66206a55e2affb5871e648e87de6dbbf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1define.html#a66206a55e2affb5871e648e87de6dbbf">define</a> (const <a class="el" href="classmsgpack_1_1define.html#afaa1391b7633eb5b3343dc2d3bb4d009">msgpack_type</a> &amp;v)</td></tr>
<tr class="separator:a66206a55e2affb5871e648e87de6dbbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3cd17ce60b06485e5c826eb11a6130c"><td class="memTemplParams" colspan="2">template&lt;typename Packer &gt; </td></tr>
<tr class="memitem:ab3cd17ce60b06485e5c826eb11a6130c"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1define.html#ab3cd17ce60b06485e5c826eb11a6130c">msgpack_pack</a> (Packer &amp;o) const</td></tr>
<tr class="separator:ab3cd17ce60b06485e5c826eb11a6130c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae414ae8ad8a7d4b3084aca0e5abdf70c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmsgpack_1_1define.html#ae414ae8ad8a7d4b3084aca0e5abdf70c">msgpack_unpack</a> (<a class="el" href="structmsgpack_1_1object.html">object</a> const &amp;o)</td></tr>
<tr class="separator:ae414ae8ad8a7d4b3084aca0e5abdf70c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ae7e8a3d402dce5fb70796fa4ee6460c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7e8a3d402dce5fb70796fa4ee6460c8">&#9670;&nbsp;</a></span>define_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classmsgpack_1_1define.html">define</a>&lt;Type&gt; <a class="el" href="classmsgpack_1_1define.html">msgpack::define</a>&lt; Type &gt;::<a class="el" href="classmsgpack_1_1define.html#ae7e8a3d402dce5fb70796fa4ee6460c8">define_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afaa1391b7633eb5b3343dc2d3bb4d009"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afaa1391b7633eb5b3343dc2d3bb4d009">&#9670;&nbsp;</a></span>msgpack_type</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
<table class="memname">
<tr>
<td class="memname">typedef Type <a class="el" href="classmsgpack_1_1define.html">msgpack::define</a>&lt; Type &gt;::<a class="el" href="classmsgpack_1_1define.html#afaa1391b7633eb5b3343dc2d3bb4d009">msgpack_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a371628638adb5968001c01b466242cf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a371628638adb5968001c01b466242cf7">&#9670;&nbsp;</a></span>define() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmsgpack_1_1define.html">msgpack::define</a>&lt; Type &gt;::<a class="el" href="classmsgpack_1_1define.html">define</a> </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="a66206a55e2affb5871e648e87de6dbbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66206a55e2affb5871e648e87de6dbbf">&#9670;&nbsp;</a></span>define() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmsgpack_1_1define.html">msgpack::define</a>&lt; Type &gt;::<a class="el" href="classmsgpack_1_1define.html">define</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmsgpack_1_1define.html#afaa1391b7633eb5b3343dc2d3bb4d009">msgpack_type</a> &amp;&#160;</td>
<td class="paramname"><em>v</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">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab3cd17ce60b06485e5c826eb11a6130c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3cd17ce60b06485e5c826eb11a6130c">&#9670;&nbsp;</a></span>msgpack_pack()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
<div class="memtemplate">
template&lt;typename Packer &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmsgpack_1_1define.html">msgpack::define</a>&lt; Type &gt;::msgpack_pack </td>
<td>(</td>
<td class="paramtype">Packer &amp;&#160;</td>
<td class="paramname"><em>o</em></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="ae414ae8ad8a7d4b3084aca0e5abdf70c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae414ae8ad8a7d4b3084aca0e5abdf70c">&#9670;&nbsp;</a></span>msgpack_unpack()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classmsgpack_1_1define.html">msgpack::define</a>&lt; Type &gt;::msgpack_unpack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmsgpack_1_1object.html">object</a> const &amp;&#160;</td>
<td class="paramname"><em>o</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="namespacemsgpack.html#aec73610d06debb4a9921afecf13b4586">msgpack::operator&gt;&gt;()</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_2object_8hpp_source.html">object.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