Google Git
Sign in
apache / qpid-site / 04beb6e78eda47fdfc2fcfc1d2eeb9a270f89a87 / . / content / releases / qpid-proton-0.32.0 / proton / cpp / api / classproton_1_1annotation__key.html
blob: daecc980728196d957aa349cb0485a7ca1527a24 [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: annotation_key</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('classproton_1_1annotation__key.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="#pub-methods">Public Member Functions</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="classproton_1_1annotation__key-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">annotation_key</div> </div>
</div><!--header-->
<div class="contents">
<p>A key for use with AMQP annotation maps.
<a href="classproton_1_1annotation__key.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="annotation__key_8hpp_source.html">annotation_key.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for annotation_key:</div>
<div class="dyncontent">
<div class="center">
<img src="classproton_1_1annotation__key.png" usemap="#annotation_5Fkey_map" alt=""/>
<map id="annotation_5Fkey_map" name="annotation_5Fkey_map">
<area href="classproton_1_1scalar__base.html" title="The base class for scalar types." alt="scalar_base" shape="rect" coords="0,56,171,80"/>
</map>
</div></div>
<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:a056f77e21066cbf900772853454102a8"><td class="memItemLeft" align="right" valign="top"><a id="a056f77e21066cbf900772853454102a8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1annotation__key.html#a056f77e21066cbf900772853454102a8">annotation_key</a> ()</td></tr>
<tr class="memdesc:a056f77e21066cbf900772853454102a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">An empty annotation key. <br /></td></tr>
<tr class="separator:a056f77e21066cbf900772853454102a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdd676d37486aa26af7fdd588f994d26"><td class="memTemplParams" colspan="2"><a id="afdd676d37486aa26af7fdd588f994d26"></a>
template&lt;class T &gt; </td></tr>
<tr class="memitem:afdd676d37486aa26af7fdd588f994d26"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1annotation__key.html#afdd676d37486aa26af7fdd588f994d26">annotation_key</a> (const T &amp;x)</td></tr>
<tr class="memdesc:afdd676d37486aa26af7fdd588f994d26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct from any type that can be assigned. <br /></td></tr>
<tr class="separator:afdd676d37486aa26af7fdd588f994d26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Assign from a uint64_t or symbol.</div></td></tr>
<tr class="memitem:a66ceb164d011d6093397953a5593b9dc"><td class="memItemLeft" align="right" valign="top"><a id="a66ceb164d011d6093397953a5593b9dc"></a>
<a class="el" href="classproton_1_1annotation__key.html">annotation_key</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (uint64_t x)</td></tr>
<tr class="separator:a66ceb164d011d6093397953a5593b9dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf5c253dc7ca30bb66f6fe057527660c"><td class="memItemLeft" align="right" valign="top"><a id="adf5c253dc7ca30bb66f6fe057527660c"></a>
<a class="el" href="classproton_1_1annotation__key.html">annotation_key</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classproton_1_1symbol.html">symbol</a> &amp;x)</td></tr>
<tr class="separator:adf5c253dc7ca30bb66f6fe057527660c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Extra conversions for strings, treated as codec::SYMBOL.</div></td></tr>
<tr class="memitem:aa20857e13b7782626fe3adeda0ef445a"><td class="memItemLeft" align="right" valign="top"><a id="aa20857e13b7782626fe3adeda0ef445a"></a>
<a class="el" href="classproton_1_1annotation__key.html">annotation_key</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const std::string &amp;x)</td></tr>
<tr class="separator:aa20857e13b7782626fe3adeda0ef445a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acde842b82d257271f07a642d344aeaa4"><td class="memItemLeft" align="right" valign="top"><a id="acde842b82d257271f07a642d344aeaa4"></a>
<a class="el" href="classproton_1_1annotation__key.html">annotation_key</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const char *x)</td></tr>
<tr class="separator:acde842b82d257271f07a642d344aeaa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classproton_1_1scalar__base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classproton_1_1scalar__base')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classproton_1_1scalar__base.html">scalar_base</a></td></tr>
<tr class="memitem:a89dd77b1757d854f49d49e379f8f9db8 inherit pub_methods_classproton_1_1scalar__base"><td class="memItemLeft" align="right" valign="top"><a id="a89dd77b1757d854f49d49e379f8f9db8"></a>
<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">type_id</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar__base.html#a89dd77b1757d854f49d49e379f8f9db8">type</a> () const</td></tr>
<tr class="memdesc:a89dd77b1757d854f49d49e379f8f9db8 inherit pub_methods_classproton_1_1scalar__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">AMQP type of data stored in the scalar. <br /></td></tr>
<tr class="separator:a89dd77b1757d854f49d49e379f8f9db8 inherit pub_methods_classproton_1_1scalar__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a644718bb2fb240de962dc3c9a1fdf0dc inherit pub_methods_classproton_1_1scalar__base"><td class="memItemLeft" align="right" valign="top"><a id="a644718bb2fb240de962dc3c9a1fdf0dc"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar__base.html#a644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () const</td></tr>
<tr class="memdesc:a644718bb2fb240de962dc3c9a1fdf0dc inherit pub_methods_classproton_1_1scalar__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if there is no value, i.e. <a class="el" href="classproton_1_1scalar__base.html#a89dd77b1757d854f49d49e379f8f9db8" title="AMQP type of data stored in the scalar.">type()</a> == NULL_TYPE. <br /></td></tr>
<tr class="separator:a644718bb2fb240de962dc3c9a1fdf0dc inherit pub_methods_classproton_1_1scalar__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:ace2642bea7a7ab2d830f42390eb4a604"><td class="memItemLeft" align="right" valign="top"><a id="ace2642bea7a7ab2d830f42390eb4a604"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:ace2642bea7a7ab2d830f42390eb4a604"><td class="memTemplItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1annotation__key.html#ace2642bea7a7ab2d830f42390eb4a604">get</a> (const <a class="el" href="classproton_1_1annotation__key.html">annotation_key</a> &amp;x)</td></tr>
<tr class="memdesc:ace2642bea7a7ab2d830f42390eb4a604"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the uint64_t value or throw <a class="el" href="structproton_1_1conversion__error.html" title="An error converting between AMQP and C++ data.">conversion_error</a>. <br /></td></tr>
<tr class="separator:ace2642bea7a7ab2d830f42390eb4a604"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab3f78c82556a26b3c2e8736a7d0c777"><td class="memItemLeft" align="right" valign="top"><a id="aab3f78c82556a26b3c2e8736a7d0c777"></a>
template&lt;&gt; </td></tr>
<tr class="memitem:aab3f78c82556a26b3c2e8736a7d0c777"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1symbol.html">symbol</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1annotation__key.html#aab3f78c82556a26b3c2e8736a7d0c777">get</a> (const <a class="el" href="classproton_1_1annotation__key.html">annotation_key</a> &amp;x)</td></tr>
<tr class="memdesc:aab3f78c82556a26b3c2e8736a7d0c777"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="classproton_1_1symbol.html">symbol</a> value or throw <a class="el" href="structproton_1_1conversion__error.html" title="An error converting between AMQP and C++ data.">conversion_error</a>. <br /></td></tr>
<tr class="separator:aab3f78c82556a26b3c2e8736a7d0c777"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab73c44b530463fda5e11bc403ca9edd3"><td class="memTemplParams" colspan="2">template&lt;class T &gt; </td></tr>
<tr class="memitem:ab73c44b530463fda5e11bc403ca9edd3"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1annotation__key.html#ab73c44b530463fda5e11bc403ca9edd3">coerce</a> (const <a class="el" href="classproton_1_1annotation__key.html">annotation_key</a> &amp;x)</td></tr>
<tr class="memdesc:ab73c44b530463fda5e11bc403ca9edd3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="classproton_1_1binary.html">binary</a> value or throw <a class="el" href="structproton_1_1conversion__error.html" title="An error converting between AMQP and C++ data.">conversion_error</a>. <a href="classproton_1_1annotation__key.html#ab73c44b530463fda5e11bc403ca9edd3">More...</a><br /></td></tr>
<tr class="separator:ab73c44b530463fda5e11bc403ca9edd3"><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>A key for use with AMQP annotation maps. </p>
<p>An <a class="el" href="classproton_1_1annotation__key.html" title="A key for use with AMQP annotation maps.">annotation_key</a> can contain either a uint64_t or a <a class="el" href="classproton_1_1symbol.html" title="A string that represents the AMQP symbol type.">proton::symbol</a>. </p>
</div><h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="ab73c44b530463fda5e11bc403ca9edd3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab73c44b530463fda5e11bc403ca9edd3">&#9670;&nbsp;</a></span>coerce()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T coerce </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classproton_1_1annotation__key.html">annotation_key</a> &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the <a class="el" href="classproton_1_1binary.html">binary</a> value or throw <a class="el" href="structproton_1_1conversion__error.html" title="An error converting between AMQP and C++ data.">conversion_error</a>. </p>
<p>Coerce the contained value to type T. For example: </p><pre class="fragment"> uint64_t i = coerce&lt;uint64_t&gt;(x)
</pre><p>This will succeed if x contains any numeric value, but may lose precision if it contains a float or double value.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="structproton_1_1conversion__error.html" title="An error converting between AMQP and C++ data.">conversion_error</a></td><td>if the value cannot be converted to T according to <code>std::is_convertible</code> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>proton/<a class="el" href="annotation__key_8hpp_source.html">annotation_key.hpp</a></li>
</ul>
</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="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1annotation__key.html">annotation_key</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>