| <!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: map< K, T ></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('classproton_1_1map.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> | |
| <a href="classproton_1_1map-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">map< K, T ></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A collection of key-value pairs. |
| <a href="classproton_1_1map.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="map_8hpp_source.html">map.hpp</a>></code></p> |
| <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:a7f35c814c022f4191d359b5dc139d35b"><td class="memItemLeft" align="right" valign="top"><a id="a7f35c814c022f4191d359b5dc139d35b"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#a7f35c814c022f4191d359b5dc139d35b">map</a> ()</td></tr> |
| <tr class="memdesc:a7f35c814c022f4191d359b5dc139d35b"><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty map. <br /></td></tr> |
| <tr class="separator:a7f35c814c022f4191d359b5dc139d35b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abd67a924a05c8bd5353cd2fa429b5272"><td class="memItemLeft" align="right" valign="top"><a id="abd67a924a05c8bd5353cd2fa429b5272"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#abd67a924a05c8bd5353cd2fa429b5272">map</a> (const <a class="el" href="classproton_1_1map.html">map</a> &)</td></tr> |
| <tr class="memdesc:abd67a924a05c8bd5353cd2fa429b5272"><td class="mdescLeft"> </td><td class="mdescRight">Copy a map. <br /></td></tr> |
| <tr class="separator:abd67a924a05c8bd5353cd2fa429b5272"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a16a75d371d4e6287b352f5066643f030"><td class="memItemLeft" align="right" valign="top"><a id="a16a75d371d4e6287b352f5066643f030"></a> |
| <a class="el" href="classproton_1_1map.html">map</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#a16a75d371d4e6287b352f5066643f030">operator=</a> (const <a class="el" href="classproton_1_1map.html">map</a> &)</td></tr> |
| <tr class="memdesc:a16a75d371d4e6287b352f5066643f030"><td class="mdescLeft"> </td><td class="mdescRight">Copy a map. <br /></td></tr> |
| <tr class="separator:a16a75d371d4e6287b352f5066643f030"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa4042115b50aa33d3e365ce1e4b254d4"><td class="memItemLeft" align="right" valign="top"><a id="aa4042115b50aa33d3e365ce1e4b254d4"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#aa4042115b50aa33d3e365ce1e4b254d4">map</a> (<a class="el" href="classproton_1_1map.html">map</a> &&)</td></tr> |
| <tr class="memdesc:aa4042115b50aa33d3e365ce1e4b254d4"><td class="mdescLeft"> </td><td class="mdescRight">Move a map. <br /></td></tr> |
| <tr class="separator:aa4042115b50aa33d3e365ce1e4b254d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab96fb2544d53f9ae42d6950c819d25ef"><td class="memItemLeft" align="right" valign="top"><a id="ab96fb2544d53f9ae42d6950c819d25ef"></a> |
| <a class="el" href="classproton_1_1map.html">map</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#ab96fb2544d53f9ae42d6950c819d25ef">operator=</a> (<a class="el" href="classproton_1_1map.html">map</a> &&)</td></tr> |
| <tr class="memdesc:ab96fb2544d53f9ae42d6950c819d25ef"><td class="mdescLeft"> </td><td class="mdescRight">Move a map. <br /></td></tr> |
| <tr class="separator:ab96fb2544d53f9ae42d6950c819d25ef"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ada6de583b7cdc95792661bcc0ff8a517"><td class="memTemplParams" colspan="2">template<class M > </td></tr> |
| <tr class="memitem:ada6de583b7cdc95792661bcc0ff8a517"><td class="memTemplItemLeft" align="right" valign="top">assignable_map< M, <a class="el" href="classproton_1_1map.html">map</a> & >::type </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#ada6de583b7cdc95792661bcc0ff8a517">operator=</a> (const M &x)</td></tr> |
| <tr class="memdesc:ada6de583b7cdc95792661bcc0ff8a517"><td class="mdescLeft"> </td><td class="mdescRight">Type-safe assign from a compatible map, for instance <code>std::map<K,T></code>. <a href="classproton_1_1map.html#ada6de583b7cdc95792661bcc0ff8a517">More...</a><br /></td></tr> |
| <tr class="separator:ada6de583b7cdc95792661bcc0ff8a517"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad7e7efff114db20e5786e0ee89a6808a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#ad7e7efff114db20e5786e0ee89a6808a">value</a> (const <a class="el" href="classproton_1_1value.html">value</a> &x)</td></tr> |
| <tr class="memdesc:ad7e7efff114db20e5786e0ee89a6808a"><td class="mdescLeft"> </td><td class="mdescRight">Copy from a <a class="el" href="classproton_1_1value.html" title="A holder for any AMQP value, simple or complex.">proton::value</a>. <a href="classproton_1_1map.html#ad7e7efff114db20e5786e0ee89a6808a">More...</a><br /></td></tr> |
| <tr class="separator:ad7e7efff114db20e5786e0ee89a6808a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad5b3d1edb6af3a91c94d7d7b38671336"><td class="memItemLeft" align="right" valign="top"><a id="ad5b3d1edb6af3a91c94d7d7b38671336"></a> |
| <a class="el" href="classproton_1_1value.html">proton::value</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#ad5b3d1edb6af3a91c94d7d7b38671336">value</a> ()</td></tr> |
| <tr class="memdesc:ad5b3d1edb6af3a91c94d7d7b38671336"><td class="mdescLeft"> </td><td class="mdescRight">Access as a <a class="el" href="classproton_1_1value.html" title="A holder for any AMQP value, simple or complex.">proton::value</a> containing an AMQP map. <br /></td></tr> |
| <tr class="separator:ad5b3d1edb6af3a91c94d7d7b38671336"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7644d6a5c6e5a2d7bb8bac2d0111fde1"><td class="memItemLeft" align="right" valign="top"><a id="a7644d6a5c6e5a2d7bb8bac2d0111fde1"></a> |
| const <a class="el" href="classproton_1_1value.html">proton::value</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#a7644d6a5c6e5a2d7bb8bac2d0111fde1">value</a> () const</td></tr> |
| <tr class="memdesc:a7644d6a5c6e5a2d7bb8bac2d0111fde1"><td class="mdescLeft"> </td><td class="mdescRight">Access as a <a class="el" href="classproton_1_1value.html" title="A holder for any AMQP value, simple or complex.">proton::value</a> containing an AMQP map. <br /></td></tr> |
| <tr class="separator:a7644d6a5c6e5a2d7bb8bac2d0111fde1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa5c42da16d5df4154dc8af4c39fbd8e0"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#aa5c42da16d5df4154dc8af4c39fbd8e0">get</a> (const K &k) const</td></tr> |
| <tr class="memdesc:aa5c42da16d5df4154dc8af4c39fbd8e0"><td class="mdescLeft"> </td><td class="mdescRight">Get the map entry for key <code>k</code>. <a href="classproton_1_1map.html#aa5c42da16d5df4154dc8af4c39fbd8e0">More...</a><br /></td></tr> |
| <tr class="separator:aa5c42da16d5df4154dc8af4c39fbd8e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac310ae7d64b7ad8a70b200c07a55a736"><td class="memItemLeft" align="right" valign="top"><a id="ac310ae7d64b7ad8a70b200c07a55a736"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#ac310ae7d64b7ad8a70b200c07a55a736">put</a> (const K &k, const T &v)</td></tr> |
| <tr class="memdesc:ac310ae7d64b7ad8a70b200c07a55a736"><td class="mdescLeft"> </td><td class="mdescRight">Put a map entry for key <code>k</code>. <br /></td></tr> |
| <tr class="separator:ac310ae7d64b7ad8a70b200c07a55a736"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa411e89b8ca1e0107c2e0c5952cf5e5e"><td class="memItemLeft" align="right" valign="top"><a id="aa411e89b8ca1e0107c2e0c5952cf5e5e"></a> |
| size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#aa411e89b8ca1e0107c2e0c5952cf5e5e">erase</a> (const K &k)</td></tr> |
| <tr class="memdesc:aa411e89b8ca1e0107c2e0c5952cf5e5e"><td class="mdescLeft"> </td><td class="mdescRight">Erase the map entry at <code>k</code>. <br /></td></tr> |
| <tr class="separator:aa411e89b8ca1e0107c2e0c5952cf5e5e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aecd4c56a12e62bf5170a3786a94c9210"><td class="memItemLeft" align="right" valign="top"><a id="aecd4c56a12e62bf5170a3786a94c9210"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#aecd4c56a12e62bf5170a3786a94c9210">exists</a> (const K &k) const</td></tr> |
| <tr class="memdesc:aecd4c56a12e62bf5170a3786a94c9210"><td class="mdescLeft"> </td><td class="mdescRight">True if the map has an entry for <code>k</code>. <br /></td></tr> |
| <tr class="separator:aecd4c56a12e62bf5170a3786a94c9210"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a259cb5a711406a8c3e5d937eb9350cca"><td class="memItemLeft" align="right" valign="top"><a id="a259cb5a711406a8c3e5d937eb9350cca"></a> |
| size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#a259cb5a711406a8c3e5d937eb9350cca">size</a> () const</td></tr> |
| <tr class="memdesc:a259cb5a711406a8c3e5d937eb9350cca"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of map entries. <br /></td></tr> |
| <tr class="separator:a259cb5a711406a8c3e5d937eb9350cca"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top"><a id="ac8bb3912a3ce86b15842e79d0b421204"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr> |
| <tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">Remove all map entries. <br /></td></tr> |
| <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memItemLeft" align="right" valign="top"><a id="a644718bb2fb240de962dc3c9a1fdf0dc"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1map.html#a644718bb2fb240de962dc3c9a1fdf0dc">empty</a> () const</td></tr> |
| <tr class="memdesc:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="mdescLeft"> </td><td class="mdescRight">True if the map has no entries. <br /></td></tr> |
| <tr class="separator:a644718bb2fb240de962dc3c9a1fdf0dc"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<class K, class T><br /> |
| class proton::map< K, T ></h3> |
| |
| <p>A collection of key-value pairs. </p> |
| <p>Used to access standard AMQP property, annotation, and filter maps attached to <a class="el" href="classproton_1_1message.html" title="An AMQP message.">proton::message</a> and <a class="el" href="classproton_1_1source.html" title="A point of origin for messages.">proton::source</a>.</p> |
| <p>This class provides only basic <a class="el" href="classproton_1_1map.html#aa5c42da16d5df4154dc8af4c39fbd8e0" title="Get the map entry for key k.">get()</a> and <a class="el" href="classproton_1_1map.html#ac310ae7d64b7ad8a70b200c07a55a736" title="Put a map entry for key k.">put()</a> operations for convenience. For more complicated uses (iteration, preserving order, and so on), convert the value to a standard C++ map type such as <code>std::map</code>. See <a class="el" href="message_properties_8cpp-example.html">message_properties.cpp</a> and <a class="el" href="types_page.html">AMQP and C++ types</a>. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ada6de583b7cdc95792661bcc0ff8a517"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ada6de583b7cdc95792661bcc0ff8a517">◆ </a></span>operator=()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">assignable_map<M, <a class="el" href="classproton_1_1map.html">map</a>&>::type operator= </td> |
| <td>(</td> |
| <td class="paramtype">const M & </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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Type-safe assign from a compatible map, for instance <code>std::map<K,T></code>. </p> |
| <p>See <a class="el" href="types_page.html">AMQP and C++ types</a>. </p> |
| |
| </div> |
| </div> |
| <a id="ad7e7efff114db20e5786e0ee89a6808a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad7e7efff114db20e5786e0ee89a6808a">◆ </a></span>value()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classproton_1_1value.html">value</a> </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classproton_1_1value.html">value</a> & </td> |
| <td class="paramname"><em>x</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Copy from a <a class="el" href="classproton_1_1value.html" title="A holder for any AMQP value, simple or complex.">proton::value</a>. </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.">proton::conversion_error</a></td><td>if <code>x</code> does not contain a compatible map. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="aa5c42da16d5df4154dc8af4c39fbd8e0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa5c42da16d5df4154dc8af4c39fbd8e0">◆ </a></span>get()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T get </td> |
| <td>(</td> |
| <td class="paramtype">const K & </td> |
| <td class="paramname"><em>k</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the map entry for key <code>k</code>. </p> |
| <p>Return <code>T()</code> if there is no such entry. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="message_properties_8cpp-example.html#a4">message_properties.cpp</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="map_8hpp_source.html">map.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_1map.html">map</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> |
