Google Git
Sign in
apache / qpid-site / 04beb6e78eda47fdfc2fcfc1d2eeb9a270f89a87 / . / content / releases / qpid-proton-0.32.0 / proton / cpp / api / type__id_8hpp.html
blob: 3a8f61603693beea2bfd04e3154998151c2aaf0a [file] [log] [blame]
<!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.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C++ API: proton/type_id.hpp 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</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">Qpid Proton C++ API
&#160;<span id="projectnumber">0.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
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.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('type__id_8hpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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="#namespaces">Namespaces</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">type_id.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Type IDs for AMQP data types.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;./internal/export.hpp&quot;</code><br />
<code>#include &lt;proton/codec.h&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
</div>
<p><a href="type__id_8hpp_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="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceproton"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html">proton</a></td></tr>
<tr class="memdesc:namespaceproton"><td class="mdescLeft">&#160;</td><td class="mdescRight">The main Proton namespace. <br /></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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a83c2656d467d69eb49725c18f5aa13a9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">type_id</a> { <br />
&#160;&#160;<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a74cf8825b522b9721ea02973803d76b4">NULL_TYPE</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a8a583f16e8d237a423c8c1d9087a4c72">BOOLEAN</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a29dfb12306aac24cadeaa1f6bac455be">UBYTE</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9aa7f492d725033c06576ac4ba21007297">BYTE</a>,
<br />
&#160;&#160;<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a9ae509995ac75484348487a7477900ca">USHORT</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a7a1fe3ba88f0c16cb494922948a9597d">SHORT</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a4756f5bbd9f28d6b8905f32024b57398">UINT</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9afd5a5f51ce25953f3db2c7e93eb7864a">INT</a>,
<br />
&#160;&#160;<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a4618cf21306b3c647741afa7ebefcab8">CHAR</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a574bf5ec73e28138b997d24464adb70c">ULONG</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9aaee055c4a5aba7d55774e4f1c01dacea">LONG</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a3f2dbbd8fe9ad35caa594416336ceeda">TIMESTAMP</a>,
<br />
&#160;&#160;<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a9cf4a0866224b0bb4a7a895da27c9c4c">FLOAT</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a33465d1d419b1074fb259ef444609e92">DOUBLE</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a8df764f32f4aeba9ac8c7baccfd73388">DECIMAL32</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a9a82428c8d08720e3134f1243496f7d6">DECIMAL64</a>,
<br />
&#160;&#160;<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9ac68fb86fda41e4314b0ee0d00e3d5170">DECIMAL128</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9aaf1ea4a849fa4bcb9d351a6bde6d7600">UUID</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9aecafbc1299672a8c1521cc0d5f1ae986">BINARY</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9aee847e634a4297b274316de8a8ca9921">STRING</a>,
<br />
&#160;&#160;<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9ae3d30ffaffa3c06ed917e565dda1fbc5">SYMBOL</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a69c9d854e6a5430635ad44693470612d">DESCRIBED</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a1e029fbf0c881b85d80fc8e89b753688">ARRAY</a>,
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a25688e799536738ea469158ef15fd1c0">LIST</a>,
<br />
&#160;&#160;<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9a4cafa5feda04184537b4d7d346e1e89b">MAP</a>
<br />
}</td></tr>
<tr class="memdesc:a83c2656d467d69eb49725c18f5aa13a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">An identifier for AMQP types. <a href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">More...</a><br /></td></tr>
<tr class="separator:a83c2656d467d69eb49725c18f5aa13a9"><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:a777b2887e8ee3a66e56ca9468007b586"><td class="memItemLeft" align="right" valign="top"><a id="a777b2887e8ee3a66e56ca9468007b586"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a777b2887e8ee3a66e56ca9468007b586">type_name</a> (type_id)</td></tr>
<tr class="memdesc:a777b2887e8ee3a66e56ca9468007b586"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the name of the AMQP type. <br /></td></tr>
<tr class="separator:a777b2887e8ee3a66e56ca9468007b586"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada44820890dab1d51fb1efd5d5d5bc95"><td class="memItemLeft" align="right" valign="top"><a id="ada44820890dab1d51fb1efd5d5d5bc95"></a>
std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html#ada44820890dab1d51fb1efd5d5d5bc95">operator&lt;&lt;</a> (std::ostream &amp;, type_id)</td></tr>
<tr class="memdesc:ada44820890dab1d51fb1efd5d5d5bc95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the type name. <br /></td></tr>
<tr class="separator:ada44820890dab1d51fb1efd5d5d5bc95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa77887032372174b09ee779f5df12056"><td class="memItemLeft" align="right" valign="top"><a id="aa77887032372174b09ee779f5df12056"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html#aa77887032372174b09ee779f5df12056">assert_type_equal</a> (type_id want, type_id got)</td></tr>
<tr class="memdesc:aa77887032372174b09ee779f5df12056"><td class="mdescLeft">&#160;</td><td class="mdescRight">Throw a <a class="el" href="structproton_1_1conversion__error.html" title="An error converting between AMQP and C++ data.">conversion_error</a> if want != got with a message including the names of the types. <br /></td></tr>
<tr class="separator:aa77887032372174b09ee779f5df12056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions to test the properties of a type ID</div></td></tr>
<tr class="memitem:aa41d60af81c2ea764268965cc7b126fa"><td class="memItemLeft" align="right" valign="top"><a id="aa41d60af81c2ea764268965cc7b126fa"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_signed_int</b> (type_id t)</td></tr>
<tr class="separator:aa41d60af81c2ea764268965cc7b126fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1aa7e03ffe4296ae2308ceea397e6fb6"><td class="memItemLeft" align="right" valign="top"><a id="a1aa7e03ffe4296ae2308ceea397e6fb6"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_unsigned_int</b> (type_id t)</td></tr>
<tr class="separator:a1aa7e03ffe4296ae2308ceea397e6fb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af97c80a0a1b477e0b5128dc7d8ed6c00"><td class="memItemLeft" align="right" valign="top"><a id="af97c80a0a1b477e0b5128dc7d8ed6c00"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_integral</b> (type_id t)</td></tr>
<tr class="separator:af97c80a0a1b477e0b5128dc7d8ed6c00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87afe800bd34d635628b34cce437d0aa"><td class="memItemLeft" align="right" valign="top"><a id="a87afe800bd34d635628b34cce437d0aa"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_floating_point</b> (type_id t)</td></tr>
<tr class="separator:a87afe800bd34d635628b34cce437d0aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68019584ba84acd90424a306dac56184"><td class="memItemLeft" align="right" valign="top"><a id="a68019584ba84acd90424a306dac56184"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_decimal</b> (type_id t)</td></tr>
<tr class="separator:a68019584ba84acd90424a306dac56184"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97cb3b1f640cf8d0036998ecb61dbb3a"><td class="memItemLeft" align="right" valign="top"><a id="a97cb3b1f640cf8d0036998ecb61dbb3a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_signed</b> (type_id t)</td></tr>
<tr class="separator:a97cb3b1f640cf8d0036998ecb61dbb3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a83051cc916ba5b67144b2e4d78ecb1"><td class="memItemLeft" align="right" valign="top"><a id="a8a83051cc916ba5b67144b2e4d78ecb1"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_string_like</b> (type_id t)</td></tr>
<tr class="separator:a8a83051cc916ba5b67144b2e4d78ecb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef7d66407548e1722486a5acd94cf01c"><td class="memItemLeft" align="right" valign="top"><a id="aef7d66407548e1722486a5acd94cf01c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_container</b> (type_id t)</td></tr>
<tr class="separator:aef7d66407548e1722486a5acd94cf01c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c5a62fde33feb4887fea1935be0a518"><td class="memItemLeft" align="right" valign="top"><a id="a7c5a62fde33feb4887fea1935be0a518"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_null</b> (type_id t)</td></tr>
<tr class="separator:a7c5a62fde33feb4887fea1935be0a518"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fa5da15b5f9ede62f8167c50c7dc656"><td class="memItemLeft" align="right" valign="top"><a id="a4fa5da15b5f9ede62f8167c50c7dc656"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>type_id_is_scalar</b> (type_id t)</td></tr>
<tr class="separator:a4fa5da15b5f9ede62f8167c50c7dc656"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Type IDs for AMQP data types. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="type__id_8hpp.html">type_id.hpp</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>