| <!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/value.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&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 |
|  <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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('value_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="#nested-classes">Classes</a> | |
| <a href="#namespaces">Namespaces</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">value.hpp File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A holder for any AMQP value, simple or complex. |
| <a href="#details">More...</a></p> |
| <div class="textblock"><code>#include "<a class="el" href="encoder_8hpp_source.html">./codec/encoder.hpp</a>"</code><br /> |
| <code>#include "<a class="el" href="decoder_8hpp_source.html">./codec/decoder.hpp</a>"</code><br /> |
| <code>#include "./internal/type_traits.hpp"</code><br /> |
| <code>#include "<a class="el" href="scalar_8hpp_source.html">./scalar.hpp</a>"</code><br /> |
| <code>#include "<a class="el" href="types__fwd_8hpp_source.html">./types_fwd.hpp</a>"</code><br /> |
| <code>#include <proton/type_compat.h></code><br /> |
| <code>#include <iosfwd></code><br /> |
| </div> |
| <p><a href="value_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="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1value.html">value</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A holder for any AMQP value, simple or complex. <a href="classproton_1_1value.html#details">More...</a><br /></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="namespaces"></a> |
| Namespaces</h2></td></tr> |
| <tr class="memitem:namespaceproton"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html">proton</a></td></tr> |
| <tr class="memdesc:namespaceproton"><td class="mdescLeft"> </td><td class="mdescRight">The main Proton namespace. <br /></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="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a051c12c4c7efc82a5f268d4f64e15b54"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a051c12c4c7efc82a5f268d4f64e15b54"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a051c12c4c7efc82a5f268d4f64e15b54">get</a> (const value &v)</td></tr> |
| <tr class="memdesc:a051c12c4c7efc82a5f268d4f64e15b54"><td class="mdescLeft"> </td><td class="mdescRight">Get a contained value of type T. <a href="namespaceproton.html#a051c12c4c7efc82a5f268d4f64e15b54">More...</a><br /></td></tr> |
| <tr class="separator:a051c12c4c7efc82a5f268d4f64e15b54"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2dd4c0151b171f03f2c36d907832522b"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a2dd4c0151b171f03f2c36d907832522b"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a2dd4c0151b171f03f2c36d907832522b">get</a> (const value &v, T &x)</td></tr> |
| <tr class="memdesc:a2dd4c0151b171f03f2c36d907832522b"><td class="mdescLeft"> </td><td class="mdescRight">Like <a class="el" href="namespaceproton.html#a051c12c4c7efc82a5f268d4f64e15b54" title="Get a contained value of type T.">get(const value&)</a> but extracts the value to a reference <code>x</code> instead of returning it. <a href="namespaceproton.html#a2dd4c0151b171f03f2c36d907832522b">More...</a><br /></td></tr> |
| <tr class="separator:a2dd4c0151b171f03f2c36d907832522b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adeafce6ab9aa5025c0fb82be5e81f922"><td class="memTemplParams" colspan="2"><a id="adeafce6ab9aa5025c0fb82be5e81f922"></a> |
| template<class T , class U > </td></tr> |
| <tr class="memitem:adeafce6ab9aa5025c0fb82be5e81f922"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>get</b> (const U &u, T &x)</td></tr> |
| <tr class="separator:adeafce6ab9aa5025c0fb82be5e81f922"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a486dfed974ca6f79e75039b3eee6c44c"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a486dfed974ca6f79e75039b3eee6c44c"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a486dfed974ca6f79e75039b3eee6c44c">coerce</a> (const value &v)</td></tr> |
| <tr class="memdesc:a486dfed974ca6f79e75039b3eee6c44c"><td class="mdescLeft"> </td><td class="mdescRight">Coerce the contained value to type T. <a href="namespaceproton.html#a486dfed974ca6f79e75039b3eee6c44c">More...</a><br /></td></tr> |
| <tr class="separator:a486dfed974ca6f79e75039b3eee6c44c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4896ec87beab7d691e1985c221c36e49"><td class="memTemplParams" colspan="2">template<class T > </td></tr> |
| <tr class="memitem:a4896ec87beab7d691e1985c221c36e49"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a4896ec87beab7d691e1985c221c36e49">coerce</a> (const value &v, T &x)</td></tr> |
| <tr class="memdesc:a4896ec87beab7d691e1985c221c36e49"><td class="mdescLeft"> </td><td class="mdescRight">Like <a class="el" href="namespaceproton.html#a486dfed974ca6f79e75039b3eee6c44c" title="Coerce the contained value to type T.">coerce(const value&)</a> but assigns the value to a reference instead of returning it. <a href="namespaceproton.html#a4896ec87beab7d691e1985c221c36e49">More...</a><br /></td></tr> |
| <tr class="separator:a4896ec87beab7d691e1985c221c36e49"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a669620a0968de2603fe8922405f1331b"><td class="memItemLeft" align="right" valign="top"><a id="a669620a0968de2603fe8922405f1331b"></a> |
| template<> </td></tr> |
| <tr class="memitem:a669620a0968de2603fe8922405f1331b"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a669620a0968de2603fe8922405f1331b">get< null ></a> (const value &v, null &)</td></tr> |
| <tr class="memdesc:a669620a0968de2603fe8922405f1331b"><td class="mdescLeft"> </td><td class="mdescRight">Special case for null, just checks that value contains NULL. <br /></td></tr> |
| <tr class="separator:a669620a0968de2603fe8922405f1331b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a565c609b3fe24b92ae8294ea1318a6bd"><td class="memItemLeft" align="right" valign="top"><a id="a565c609b3fe24b92ae8294ea1318a6bd"></a> |
| template<> </td></tr> |
| <tr class="memitem:a565c609b3fe24b92ae8294ea1318a6bd"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a565c609b3fe24b92ae8294ea1318a6bd">get< decltype(nullptr)></a> (const value &v, decltype(nullptr)&)</td></tr> |
| <tr class="memdesc:a565c609b3fe24b92ae8294ea1318a6bd"><td class="mdescLeft"> </td><td class="mdescRight">Special case for null, just checks that value contains NULL. <br /></td></tr> |
| <tr class="separator:a565c609b3fe24b92ae8294ea1318a6bd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8c46a4cbeb5a6150ab40ea81ee4bfb81"><td class="memItemLeft" align="right" valign="top"><a id="a8c46a4cbeb5a6150ab40ea81ee4bfb81"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceproton.html#a8c46a4cbeb5a6150ab40ea81ee4bfb81">to_string</a> (const value &x)</td></tr> |
| <tr class="memdesc:a8c46a4cbeb5a6150ab40ea81ee4bfb81"><td class="mdescLeft"> </td><td class="mdescRight">Return a readable string representation of x for display purposes. <br /></td></tr> |
| <tr class="separator:a8c46a4cbeb5a6150ab40ea81ee4bfb81"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A holder for any AMQP value, simple or complex. </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="value_8hpp.html">value.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> |