http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1receiver__options.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1receiver__options.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1receiver__options.html new file mode 100755 index 0000000..d64fbb5 --- /dev/null +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1receiver__options.html @@ -0,0 +1,230 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.10"/> +<title>Qpid Proton C++ API: receiver_options</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> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</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"> + $(document).ready(function() { init_search(); }); +</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">master</span> + </div> + </td> + <td> <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + 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.png" alt=""/></a> + </span> + </div> +</td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.10 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</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"> +$(document).ready(function(){initNavTree('classproton_1_1receiver__options.html','');}); +</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_1receiver__options-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">receiver_options</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Options for creating a receiver. + <a href="classproton_1_1receiver__options.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="receiver__options_8hpp_source.html">receiver_options.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:a9e10a473b92db75e78a3ad8498f32c36"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e10a473b92db75e78a3ad8498f32c36"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a9e10a473b92db75e78a3ad8498f32c36">receiver_options</a> ()</td></tr> +<tr class="memdesc:a9e10a473b92db75e78a3ad8498f32c36"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty set of options. <br /></td></tr> +<tr class="separator:a9e10a473b92db75e78a3ad8498f32c36"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a09be031fe2c8df29e3f0f1b0f1c904c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09be031fe2c8df29e3f0f1b0f1c904c3"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a09be031fe2c8df29e3f0f1b0f1c904c3">receiver_options</a> (const <a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> &)</td></tr> +<tr class="memdesc:a09be031fe2c8df29e3f0f1b0f1c904c3"><td class="mdescLeft"> </td><td class="mdescRight">Copy options. <br /></td></tr> +<tr class="separator:a09be031fe2c8df29e3f0f1b0f1c904c3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a815be8018205013b8ff011d4b62b7324"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a815be8018205013b8ff011d4b62b7324"></a> +<a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a815be8018205013b8ff011d4b62b7324">operator=</a> (const <a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> &)</td></tr> +<tr class="memdesc:a815be8018205013b8ff011d4b62b7324"><td class="mdescLeft"> </td><td class="mdescRight">Copy options. <br /></td></tr> +<tr class="separator:a815be8018205013b8ff011d4b62b7324"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7bbed67f2faac1cd6a5c490dac90bda3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7bbed67f2faac1cd6a5c490dac90bda3"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a7bbed67f2faac1cd6a5c490dac90bda3">update</a> (const <a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> &other)</td></tr> +<tr class="memdesc:a7bbed67f2faac1cd6a5c490dac90bda3"><td class="mdescLeft"> </td><td class="mdescRight">Merge with another option set. <br /></td></tr> +<tr class="separator:a7bbed67f2faac1cd6a5c490dac90bda3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a84f38ac0f31f74011c9dc342e44a53df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a84f38ac0f31f74011c9dc342e44a53df">handler</a> (class <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> &)</td></tr> +<tr class="memdesc:a84f38ac0f31f74011c9dc342e44a53df"><td class="mdescLeft"> </td><td class="mdescRight">Set a <a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">messaging_handler</a> for receiver events only. <a href="#a84f38ac0f31f74011c9dc342e44a53df">More...</a><br /></td></tr> +<tr class="separator:a84f38ac0f31f74011c9dc342e44a53df"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a582bced77754ed8a85f9597e2e457079"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a582bced77754ed8a85f9597e2e457079"></a> +<a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a582bced77754ed8a85f9597e2e457079">delivery_mode</a> (<a class="el" href="structproton_1_1delivery__mode.html">delivery_mode</a>)</td></tr> +<tr class="memdesc:a582bced77754ed8a85f9597e2e457079"><td class="mdescLeft"> </td><td class="mdescRight">Set the delivery mode on the receiver. <br /></td></tr> +<tr class="separator:a582bced77754ed8a85f9597e2e457079"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9b9ad83418de47f87c6c7062eaefb5b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a9b9ad83418de47f87c6c7062eaefb5b6">auto_accept</a> (bool)</td></tr> +<tr class="memdesc:a9b9ad83418de47f87c6c7062eaefb5b6"><td class="mdescLeft"> </td><td class="mdescRight">Automatically accept inbound messages that aren't otherwise released, rejected, or modified (default is true). <a href="#a9b9ad83418de47f87c6c7062eaefb5b6">More...</a><br /></td></tr> +<tr class="separator:a9b9ad83418de47f87c6c7062eaefb5b6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af313abfa8d5b19e4b61c779907eb9980"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af313abfa8d5b19e4b61c779907eb9980"></a> +<a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#af313abfa8d5b19e4b61c779907eb9980">auto_settle</a> (bool)</td></tr> +<tr class="memdesc:af313abfa8d5b19e4b61c779907eb9980"><td class="mdescLeft"> </td><td class="mdescRight">Automatically settle messages (default is true). <br /></td></tr> +<tr class="separator:af313abfa8d5b19e4b61c779907eb9980"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7e2689fd52f88f551d11face38a4157b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e2689fd52f88f551d11face38a4157b"></a> +<a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a7e2689fd52f88f551d11face38a4157b">source</a> (<a class="el" href="classproton_1_1source__options.html">source_options</a> &)</td></tr> +<tr class="memdesc:a7e2689fd52f88f551d11face38a4157b"><td class="mdescLeft"> </td><td class="mdescRight">Options for the source node of the receiver. <br /></td></tr> +<tr class="separator:a7e2689fd52f88f551d11face38a4157b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7823f6c72dc78481be578de1658b99eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7823f6c72dc78481be578de1658b99eb"></a> +<a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a7823f6c72dc78481be578de1658b99eb">target</a> (<a class="el" href="classproton_1_1target__options.html">target_options</a> &)</td></tr> +<tr class="memdesc:a7823f6c72dc78481be578de1658b99eb"><td class="mdescLeft"> </td><td class="mdescRight">Options for the target node of the receiver. <br /></td></tr> +<tr class="separator:a7823f6c72dc78481be578de1658b99eb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0d332416daba4af0ce5cf6677b497226"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1receiver__options.html#a0d332416daba4af0ce5cf6677b497226">credit_window</a> (int)</td></tr> +<tr class="memdesc:a0d332416daba4af0ce5cf6677b497226"><td class="mdescLeft"> </td><td class="mdescRight">Set automated flow control to pre-fetch this many messages (default is 10). <a href="#a0d332416daba4af0ce5cf6677b497226">More...</a><br /></td></tr> +<tr class="separator:a0d332416daba4af0ce5cf6677b497226"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Options for creating a receiver. </p> +<p>Options can be "chained" like this:</p> +<div class="fragment"><div class="line">l = container.create_receiver(url, <a class="code" href="classproton_1_1receiver__options.html#a9e10a473b92db75e78a3ad8498f32c36">receiver_options</a>().<a class="code" href="classproton_1_1receiver__options.html#a84f38ac0f31f74011c9dc342e44a53df">handler</a>(h).<a class="code" href="classproton_1_1receiver__options.html#af313abfa8d5b19e4b61c779907eb9980">auto_settle</a>(<span class="keyword">true</span>));</div> +</div><!-- fragment --><p>You can also create an options object with common settings and use it as a base for different connections that have mostly the same settings:</p> +<div class="fragment"><div class="line"><a class="code" href="classproton_1_1receiver__options.html#a9e10a473b92db75e78a3ad8498f32c36">receiver_options</a> opts;</div> +<div class="line">opts.auto_settle(<span class="keyword">true</span>);</div> +<div class="line">c2 = container.open_receiver(url2, opts.handler(h2));</div> +</div><!-- fragment --><p>Normal value semantics: copy or assign creates a separate copy of the options. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a9b9ad83418de47f87c6c7062eaefb5b6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classproton_1_1receiver__options.html">receiver_options</a>& auto_accept </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Automatically accept inbound messages that aren't otherwise released, rejected, or modified (default is true). </p> + +</div> +</div> +<a class="anchor" id="a0d332416daba4af0ce5cf6677b497226"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classproton_1_1receiver__options.html">receiver_options</a>& credit_window </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set automated flow control to pre-fetch this many messages (default is 10). </p> +<p>Set to zero to disable automatic credit replenishing. </p> + +</div> +</div> +<a class="anchor" id="a84f38ac0f31f74011c9dc342e44a53df"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classproton_1_1receiver__options.html">receiver_options</a>& handler </td> + <td>(</td> + <td class="paramtype">class <a class="el" href="classproton_1_1messaging__handler.html">messaging_handler</a> & </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Set a <a class="el" href="classproton_1_1messaging__handler.html" title="A handler for Proton messaging events. ">messaging_handler</a> for receiver events only. </p> +<p>The handler is no longer in use when <a class="el" href="classproton_1_1messaging__handler.html#a77ac5c1fd05404728451cd06dee1c907" title="The remote peer closed the link. ">messaging_handler::on_receiver_close()</a> is called. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>proton/<a class="el" href="receiver__options_8hpp_source.html">receiver_options.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_1receiver__options.html">receiver_options</a></li> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.10 </li> + </ul> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1receiver__options.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1receiver__options.js b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1receiver__options.js new file mode 100755 index 0000000..e65f97d --- /dev/null +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1receiver__options.js @@ -0,0 +1,15 @@ +var classproton_1_1receiver__options = +[ + [ "receiver_options", "classproton_1_1receiver__options.html#a9e10a473b92db75e78a3ad8498f32c36", null ], + [ "receiver_options", "classproton_1_1receiver__options.html#a09be031fe2c8df29e3f0f1b0f1c904c3", null ], + [ "~receiver_options", "classproton_1_1receiver__options.html#ad8168a06620ae6844cb61451d065f4f3", null ], + [ "auto_accept", "classproton_1_1receiver__options.html#a9b9ad83418de47f87c6c7062eaefb5b6", null ], + [ "auto_settle", "classproton_1_1receiver__options.html#af313abfa8d5b19e4b61c779907eb9980", null ], + [ "credit_window", "classproton_1_1receiver__options.html#a0d332416daba4af0ce5cf6677b497226", null ], + [ "delivery_mode", "classproton_1_1receiver__options.html#a582bced77754ed8a85f9597e2e457079", null ], + [ "handler", "classproton_1_1receiver__options.html#a84f38ac0f31f74011c9dc342e44a53df", null ], + [ "operator=", "classproton_1_1receiver__options.html#a815be8018205013b8ff011d4b62b7324", null ], + [ "source", "classproton_1_1receiver__options.html#a7e2689fd52f88f551d11face38a4157b", null ], + [ "target", "classproton_1_1receiver__options.html#a7823f6c72dc78481be578de1658b99eb", null ], + [ "update", "classproton_1_1receiver__options.html#a7bbed67f2faac1cd6a5c490dac90bda3", null ] +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar-members.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar-members.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar-members.html index a4ce06f..c045a27 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar-members.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar-members.html @@ -103,7 +103,6 @@ $(document).ready(function(){initNavTree('classproton_1_1scalar.html','');}); <tr class="even"><td class="entry"><a class="el" href="classproton_1_1scalar.html#a7166ca618a14fe7e669059cb2ebbdb8f">operator=</a>(const T &x)</td><td class="entry"><a class="el" href="classproton_1_1scalar.html">scalar</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classproton_1_1scalar.html#a79453d11d5d0a0ab021762a68a73d97e">scalar</a>()</td><td class="entry"><a class="el" href="classproton_1_1scalar.html">scalar</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr class="even"><td class="entry"><a class="el" href="classproton_1_1scalar.html#a247e504774a50ea9baeb9330d459a486">scalar</a>(const T &x)</td><td class="entry"><a class="el" href="classproton_1_1scalar.html">scalar</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1scalar__base.html#a6a70b946e3620c70eac8e97f7f33fb27">type</a>() const </td><td class="entry"><a class="el" href="classproton_1_1scalar__base.html">scalar_base</a></td><td class="entry"></td></tr> </table></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.html index 0e3f62f..cfadb44 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('classproton_1_1scalar.html','');}); </div><!--header--> <div class="contents"> -<p>A holder for an instance of any scalar AMQP type, see <a class="el" href="types.html">AMQP and C++ types</a>. +<p>A holder for an instance of any scalar AMQP type. <a href="classproton_1_1scalar.html#details">More...</a></p> <p><code>#include <<a class="el" href="scalar_8hpp_source.html">scalar.hpp</a>></code></p> @@ -108,7 +108,6 @@ Inheritance diagram for scalar:</div> <div class="center"> <img src="classproton_1_1scalar.png" usemap="#scalar_map" alt=""/> <map id="scalar_map" name="scalar_map"> -<area href="classproton_1_1scalar__base.html" title="Base class for scalar types. " alt="scalar_base" shape="rect" coords="0,0,81,24"/> </map> </div></div> <table class="memberdecls"> @@ -121,25 +120,21 @@ Public Member Functions</h2></td></tr> <tr class="memitem:a247e504774a50ea9baeb9330d459a486"><td class="memTemplParams" colspan="2"><a class="anchor" id="a247e504774a50ea9baeb9330d459a486"></a> template<class T > </td></tr> <tr class="memitem:a247e504774a50ea9baeb9330d459a486"><td class="memTemplItemLeft" align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#a247e504774a50ea9baeb9330d459a486">scalar</a> (const T &x)</td></tr> -<tr class="memdesc:a247e504774a50ea9baeb9330d459a486"><td class="mdescLeft"> </td><td class="mdescRight">Construct from any scalar type, see <a class="el" href="types.html">AMQP and C++ types</a>. <br /></td></tr> +<tr class="memdesc:a247e504774a50ea9baeb9330d459a486"><td class="mdescLeft"> </td><td class="mdescRight">Construct from any scalar type. <br /></td></tr> <tr class="separator:a247e504774a50ea9baeb9330d459a486"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7166ca618a14fe7e669059cb2ebbdb8f"><td class="memTemplParams" colspan="2"><a class="anchor" id="a7166ca618a14fe7e669059cb2ebbdb8f"></a> template<class T > </td></tr> <tr class="memitem:a7166ca618a14fe7e669059cb2ebbdb8f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1scalar.html">scalar</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#a7166ca618a14fe7e669059cb2ebbdb8f">operator=</a> (const T &x)</td></tr> -<tr class="memdesc:a7166ca618a14fe7e669059cb2ebbdb8f"><td class="mdescLeft"> </td><td class="mdescRight">Assign from any scalar type, see <a class="el" href="types.html">AMQP and C++ types</a>. <br /></td></tr> +<tr class="memdesc:a7166ca618a14fe7e669059cb2ebbdb8f"><td class="mdescLeft"> </td><td class="mdescRight">Assign from any scalar type. <br /></td></tr> <tr class="separator:a7166ca618a14fe7e669059cb2ebbdb8f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac6e61de369e994009e36f344f99c15ad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6e61de369e994009e36f344f99c15ad"></a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#ac6e61de369e994009e36f344f99c15ad">empty</a> () const </td></tr> -<tr class="memdesc:ac6e61de369e994009e36f344f99c15ad"><td class="mdescLeft"> </td><td class="mdescRight">No contents, <a class="el" href="classproton_1_1scalar__base.html#a6a70b946e3620c70eac8e97f7f33fb27" title="AMQP type of data stored in the scalar. ">type()</a> == NULL_TYPE. <br /></td></tr> +<tr class="memdesc:ac6e61de369e994009e36f344f99c15ad"><td class="mdescLeft"> </td><td class="mdescRight">True if type() == NULL_TYPE. <br /></td></tr> <tr class="separator:ac6e61de369e994009e36f344f99c15ad"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr> -<tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">Clear the scalar, make it <a class="el" href="classproton_1_1scalar.html#ac6e61de369e994009e36f344f99c15ad" title="No contents, type() == NULL_TYPE. ">empty()</a> <br /></td></tr> +<tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">Clear the scalar, making it <a class="el" href="classproton_1_1scalar.html#ac6e61de369e994009e36f344f99c15ad" title="True if type() == NULL_TYPE. ">empty()</a>. <br /></td></tr> <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6a70b946e3620c70eac8e97f7f33fb27"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a70b946e3620c70eac8e97f7f33fb27"></a> -<a class="el" href="namespaceproton.html#a83c2656d467d69eb49725c18f5aa13a9">type_id</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1scalar__base.html#a6a70b946e3620c70eac8e97f7f33fb27">type</a> () const </td></tr> -<tr class="memdesc:a6a70b946e3620c70eac8e97f7f33fb27"><td class="mdescLeft"> </td><td class="mdescRight">AMQP type of data stored in the scalar. <br /></td></tr> -<tr class="separator:a6a70b946e3620c70eac8e97f7f33fb27"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a> Related Functions</h2></td></tr> @@ -155,7 +150,8 @@ Related Functions</h2></td></tr> <tr class="separator:a59517f5cda18ae5c612f0c760398fe1d"><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 an instance of any scalar AMQP type, see <a class="el" href="types.html">AMQP and C++ types</a>. </p> +<div class="textblock"><p>A holder for an instance of any scalar AMQP type. </p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="types_page.html">AMQP and C++ types</a> </dd></dl> </div><h2 class="groupheader">Friends And Related Function Documentation</h2> <a class="anchor" id="a59517f5cda18ae5c612f0c760398fe1d"></a> <div class="memitem"> @@ -181,10 +177,10 @@ Related Functions</h2></td></tr> <p>Coerce the contained value to type T. </p> <p>For example: </p><pre class="fragment">uint64_t i = get<uint64_t>(x) -</pre><p>Will succeed if x contains any numeric value, but may lose precision if it contains a float or double value.</p> +</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="Raised if there is 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> + <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> @@ -215,10 +211,10 @@ Related Functions</h2></td></tr> <p>Get a contained value of type T. </p> <p>For example: </p><pre class="fragment">uint64_t i = get<uint64_t>(x) -</pre><p>Will succeed if and only if x contains a uint64_t value.</p> +</pre><p>This will succeed if and only if x contains a uint64_t 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="Raised if there is an error converting between AMQP and C++ data. ">conversion_error</a></td><td>if contained value is not of type T. </td></tr> + <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 contained value is not of type T. </td></tr> </table> </dd> </dl> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.js b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.js index 970682e..4227839 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.js +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.js @@ -5,7 +5,6 @@ var classproton_1_1scalar = [ "clear", "classproton_1_1scalar.html#ac8bb3912a3ce86b15842e79d0b421204", null ], [ "empty", "classproton_1_1scalar.html#ac6e61de369e994009e36f344f99c15ad", null ], [ "operator=", "classproton_1_1scalar.html#a7166ca618a14fe7e669059cb2ebbdb8f", null ], - [ "type", "classproton_1_1scalar.html#a6a70b946e3620c70eac8e97f7f33fb27", null ], [ "coerce", "classproton_1_1scalar.html#a59517f5cda18ae5c612f0c760398fe1d", null ], [ "get", "classproton_1_1scalar.html#a61968283b9e1fc067dcad67e9fe58f6a", null ] ]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.png ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.png b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.png index dd9c4a6..db364ea 100755 Binary files a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.png and b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1scalar.png differ http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender-members.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender-members.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender-members.html index 8e970c1..d1ae140 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender-members.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender-members.html @@ -96,37 +96,27 @@ $(document).ready(function(){initNavTree('classproton_1_1sender.html','');}); <p>This is the complete list of members for <a class="el" href="classproton_1_1sender.html">sender</a>, including all inherited members.</p> <table class="directory"> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#a5ae591df94fc66ccb85cbb6565368bca">close</a>()</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1link.html#af13d10fc3d843719af9ff4c456330a73">connection</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#a604ee46e04955a2323f305b4a81017a0">container</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1link.html#a75360c7515b9f569871c5ea953286649">credit</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#ac295bade8aee589f6718dfa79edc2a34">detach</a>()</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr bgcolor="#f0f0f0"><td class="entry"><b>link</b>() (defined in <a class="el" href="classproton_1_1link.html">link</a>)</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1endpoint.html#aa9bb5c15062bee80022f56bffcf2868a">LOCAL_ACTIVE</a></td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1endpoint.html#a4f8d870a4ace6dd1be8728f0e3ccf23c">LOCAL_CLOSED</a></td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#aaaea8dc733566e78a066d2435f8a60c5">local_condition</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1endpoint.html#a5017b4c4cc25f9c0932455e13fb223d4">LOCAL_MASK</a></td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#a2246ba119cbaa626fb423e1ba80f84c5">local_source</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1link.html#a1e65cc5198f2c2e57d28815f401eb7d9">local_target</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1endpoint.html#a84e5c2baecd6fd28505eac28ab14bacb">LOCAL_UNINIT</a></td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"><span class="mlabel">static</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#a6fd1dc792a0b98e6530a7383d4ef3074">active</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1link.html#a5ae591df94fc66ccb85cbb6565368bca">close</a>()</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#a817883d28ce0ac8a29d917d196796f68">close</a>(const error_condition &)</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1link.html#a24c88f59fb7d18a293dbc5e6cbebd744">closed</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#af13d10fc3d843719af9ff4c456330a73">connection</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1link.html#a604ee46e04955a2323f305b4a81017a0">container</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#a75360c7515b9f569871c5ea953286649">credit</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1link.html#ac295bade8aee589f6718dfa79edc2a34">detach</a>()</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#a19c36a38b50e8080b94a47230a56234f">draining</a>()</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1link.html#ae94b11511c3ff52ec5b4988122a232ff">error</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#ad29b379b3621ec393ac9f28b4ba8b010">link</a>()</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> <tr><td class="entry"><a class="el" href="classproton_1_1link.html#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#afdfda4724950dfecdbc2e74b6a888998">open</a>(const link_options &opts=link_options())</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1link.html#a42add3dc24b98be816b02f7ba64737f4">queued</a>()</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#ab8db92c685717230b2f19be20c660005">receiver</a>()</td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1link.html#a08a29346f1a6b36085afc57cbba90894">receiver</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1endpoint.html#aa1f09a6f628fac670f0f92601155e155">REMOTE_ACTIVE</a></td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1endpoint.html#a37089f32d6a3324908be74116dfe6820">REMOTE_CLOSED</a></td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#a492e060bda7b5f5a49a9e5cd19f92834">remote_condition</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1endpoint.html#a5ee39a5f2e921db5be1c2a0e56035761">REMOTE_MASK</a></td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#adc8d612ee69e5722919c1bc2c95df66e">remote_source</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1link.html#ad5797a56dcc8453297ee6551fed06a95">remote_target</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1endpoint.html#aca8e5dcefe432fcb32f48dc0433cf5ca">REMOTE_UNINIT</a></td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"><span class="mlabel">static</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1sender.html#aefaf5ace497245ca76c6c9d629ae7bee">send</a>(const message &m)</td><td class="entry"><a class="el" href="classproton_1_1sender.html">sender</a></td><td class="entry"></td></tr> - <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>sender</b>() (defined in <a class="el" href="classproton_1_1sender.html">sender</a>)</td><td class="entry"><a class="el" href="classproton_1_1sender.html">sender</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1link.html#aa29986e9373916447665a8791845e7cf">proton::link::sender</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#aa33faff52aea9845efaf184f86676cc5">session</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr><td class="entry"><a class="el" href="classproton_1_1link.html#a1e2622353881ca93799c7d127a1464ce">state</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> - <tr class="even"><td class="entry"><a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">proton::endpoint::state</a> typedef</td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1sender.html#a9e8555112049fc2b4945120b3c45f8ab">open</a>()</td><td class="entry"><a class="el" href="classproton_1_1sender.html">sender</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1sender.html#a0177dfbb87c4a94379c4ab6ac77a134e">open</a>(const sender_options &opts)</td><td class="entry"><a class="el" href="classproton_1_1sender.html">sender</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1sender.html#abc4cb5f2f38643abb47c0b221a130bc8">return_credit</a>()</td><td class="entry"><a class="el" href="classproton_1_1sender.html">sender</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1sender.html#a214eb30b24e6831d016a47b9dddda830">send</a>(const message &m)</td><td class="entry"><a class="el" href="classproton_1_1sender.html">sender</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1sender.html#ae8473244d5665777c846fa88eba39252">sender</a>()</td><td class="entry"><a class="el" href="classproton_1_1sender.html">sender</a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1link.html#aa33faff52aea9845efaf184f86676cc5">session</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1sender.html#a2f1d8ca25f71dff178c462cf984327f9">source</a>() const </td><td class="entry"><a class="el" href="classproton_1_1sender.html">sender</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classproton_1_1sender.html#a68cde95e630ce554bb4a2ba9ef087a17">target</a>() const </td><td class="entry"><a class="el" href="classproton_1_1sender.html">sender</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classproton_1_1link.html#ac148c054a035b462f4483f38078374bf">uninitialized</a>() const </td><td class="entry"><a class="el" href="classproton_1_1link.html">link</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> <tr bgcolor="#f0f0f0"><td class="entry"><b>~endpoint</b>() (defined in <a class="el" href="classproton_1_1endpoint.html">endpoint</a>)</td><td class="entry"><a class="el" href="classproton_1_1endpoint.html">endpoint</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr> </table></div><!-- contents --> </div><!-- doc-content --> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/627da724/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender.html b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender.html index 6a949eb..d83d67e 100755 --- a/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender.html +++ b/content/releases/qpid-proton-master/proton/cpp/api/classproton_1_1sender.html @@ -90,16 +90,14 @@ $(document).ready(function(){initNavTree('classproton_1_1sender.html','');}); <div class="header"> <div class="summary"> -<a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | -<a href="#pub-static-attribs">Static Public Attributes</a> | <a href="classproton_1_1sender-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">sender</div> </div> </div><!--header--> <div class="contents"> -<p>A link for sending messages. +<p>A channel for sending messages. <a href="classproton_1_1sender.html#details">More...</a></p> <p><code>#include <<a class="el" href="sender_8hpp_source.html">sender.hpp</a>></code></p> @@ -109,56 +107,60 @@ Inheritance diagram for sender:</div> <div class="center"> <img src="classproton_1_1sender.png" usemap="#sender_map" alt=""/> <map id="sender_map" name="sender_map"> -<area href="classproton_1_1link.html" title="A named channel for sending or receiving messages. " alt="link" shape="rect" coords="0,56,60,80"/> -<area href="classproton_1_1endpoint.html" title="The base class for session, connection, and link. " alt="endpoint" shape="rect" coords="0,0,60,24"/> +<area href="classproton_1_1link.html" title="A named channel for sending or receiving messages. " alt="link" shape="rect" coords="110,112,320,136"/> +<area href="classproton_1_1endpoint.html" title="The base class for session, connection, and link. " alt="endpoint" shape="rect" coords="220,56,430,80"/> </map> </div></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:a9660be8f45524b15c3931fb752de3b3e"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a></td></tr> -<tr class="memdesc:a9660be8f45524b15c3931fb752de3b3e"><td class="mdescLeft"> </td><td class="mdescRight">A bit mask of state bit values. <a href="#a9660be8f45524b15c3931fb752de3b3e">More...</a><br /></td></tr> -<tr class="separator:a9660be8f45524b15c3931fb752de3b3e"><td class="memSeparator" colspan="2"> </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:aefaf5ace497245ca76c6c9d629ae7bee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aefaf5ace497245ca76c6c9d629ae7bee"></a> -<a class="el" href="classproton_1_1delivery.html">delivery</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#aefaf5ace497245ca76c6c9d629ae7bee">send</a> (const <a class="el" href="classproton_1_1message.html">message</a> &m)</td></tr> -<tr class="memdesc:aefaf5ace497245ca76c6c9d629ae7bee"><td class="mdescLeft"> </td><td class="mdescRight">Send a message on the link. <br /></td></tr> -<tr class="separator:aefaf5ace497245ca76c6c9d629ae7bee"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af13d10fc3d843719af9ff4c456330a73"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af13d10fc3d843719af9ff4c456330a73"></a> -class <a class="el" href="classproton_1_1connection.html">connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#af13d10fc3d843719af9ff4c456330a73">connection</a> () const </td></tr> -<tr class="memdesc:af13d10fc3d843719af9ff4c456330a73"><td class="mdescLeft"> </td><td class="mdescRight">Connection that owns this link. <br /></td></tr> -<tr class="separator:af13d10fc3d843719af9ff4c456330a73"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ab8db92c685717230b2f19be20c660005"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8db92c685717230b2f19be20c660005"></a> -class <a class="el" href="classproton_1_1receiver.html">receiver</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ab8db92c685717230b2f19be20c660005">receiver</a> ()</td></tr> -<tr class="memdesc:ab8db92c685717230b2f19be20c660005"><td class="mdescLeft"> </td><td class="mdescRight">Return receiver if this link is a receiver, 0 if not. <br /></td></tr> -<tr class="separator:ab8db92c685717230b2f19be20c660005"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a08a29346f1a6b36085afc57cbba90894"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08a29346f1a6b36085afc57cbba90894"></a> -const class <a class="el" href="classproton_1_1receiver.html">receiver</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a08a29346f1a6b36085afc57cbba90894">receiver</a> () const </td></tr> -<tr class="memdesc:a08a29346f1a6b36085afc57cbba90894"><td class="mdescLeft"> </td><td class="mdescRight">Return receiver if this link is a receiver, 0 if not. <br /></td></tr> -<tr class="separator:a08a29346f1a6b36085afc57cbba90894"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa29986e9373916447665a8791845e7cf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa29986e9373916447665a8791845e7cf"></a> -const class <a class="el" href="classproton_1_1sender.html">sender</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#aa29986e9373916447665a8791845e7cf">sender</a> () const </td></tr> -<tr class="memdesc:aa29986e9373916447665a8791845e7cf"><td class="mdescLeft"> </td><td class="mdescRight">Return sender if this link is a sender, 0 if not. <br /></td></tr> -<tr class="separator:aa29986e9373916447665a8791845e7cf"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1e2622353881ca93799c7d127a1464ce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e2622353881ca93799c7d127a1464ce"></a> -<a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">endpoint::state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a1e2622353881ca93799c7d127a1464ce">state</a> () const </td></tr> -<tr class="memdesc:a1e2622353881ca93799c7d127a1464ce"><td class="mdescLeft"> </td><td class="mdescRight">Get the state of this link. <br /></td></tr> -<tr class="separator:a1e2622353881ca93799c7d127a1464ce"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aaaea8dc733566e78a066d2435f8a60c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1condition.html">condition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#aaaea8dc733566e78a066d2435f8a60c5">local_condition</a> () const </td></tr> -<tr class="memdesc:aaaea8dc733566e78a066d2435f8a60c5"><td class="mdescLeft"> </td><td class="mdescRight">XXX add endpoint state boolean operations. <a href="#aaaea8dc733566e78a066d2435f8a60c5">More...</a><br /></td></tr> -<tr class="separator:aaaea8dc733566e78a066d2435f8a60c5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a492e060bda7b5f5a49a9e5cd19f92834"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a492e060bda7b5f5a49a9e5cd19f92834"></a> -<a class="el" href="classproton_1_1condition.html">condition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a492e060bda7b5f5a49a9e5cd19f92834">remote_condition</a> () const </td></tr> -<tr class="memdesc:a492e060bda7b5f5a49a9e5cd19f92834"><td class="mdescLeft"> </td><td class="mdescRight">Get the error condition of the remote endpoint. <br /></td></tr> -<tr class="separator:a492e060bda7b5f5a49a9e5cd19f92834"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:afdfda4724950dfecdbc2e74b6a888998"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#afdfda4724950dfecdbc2e74b6a888998">open</a> (const <a class="el" href="classproton_1_1link__options.html">link_options</a> &opts=<a class="el" href="classproton_1_1link__options.html">link_options</a>())</td></tr> -<tr class="memdesc:afdfda4724950dfecdbc2e74b6a888998"><td class="mdescLeft"> </td><td class="mdescRight">Locally open the link. <a href="#afdfda4724950dfecdbc2e74b6a888998">More...</a><br /></td></tr> -<tr class="separator:afdfda4724950dfecdbc2e74b6a888998"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae8473244d5665777c846fa88eba39252"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8473244d5665777c846fa88eba39252"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#ae8473244d5665777c846fa88eba39252">sender</a> ()</td></tr> +<tr class="memdesc:ae8473244d5665777c846fa88eba39252"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty sender. <br /></td></tr> +<tr class="separator:ae8473244d5665777c846fa88eba39252"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9e8555112049fc2b4945120b3c45f8ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#a9e8555112049fc2b4945120b3c45f8ab">open</a> ()</td></tr> +<tr class="memdesc:a9e8555112049fc2b4945120b3c45f8ab"><td class="mdescLeft"> </td><td class="mdescRight">Open the sender. <a href="#a9e8555112049fc2b4945120b3c45f8ab">More...</a><br /></td></tr> +<tr class="separator:a9e8555112049fc2b4945120b3c45f8ab"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0177dfbb87c4a94379c4ab6ac77a134e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#a0177dfbb87c4a94379c4ab6ac77a134e">open</a> (const <a class="el" href="classproton_1_1sender__options.html">sender_options</a> &opts)</td></tr> +<tr class="memdesc:a0177dfbb87c4a94379c4ab6ac77a134e"><td class="mdescLeft"> </td><td class="mdescRight">Open the sender. <a href="#a0177dfbb87c4a94379c4ab6ac77a134e">More...</a><br /></td></tr> +<tr class="separator:a0177dfbb87c4a94379c4ab6ac77a134e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a214eb30b24e6831d016a47b9dddda830"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a214eb30b24e6831d016a47b9dddda830"></a> +<a class="el" href="classproton_1_1tracker.html">tracker</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#a214eb30b24e6831d016a47b9dddda830">send</a> (const <a class="el" href="classproton_1_1message.html">message</a> &m)</td></tr> +<tr class="memdesc:a214eb30b24e6831d016a47b9dddda830"><td class="mdescLeft"> </td><td class="mdescRight">Send a message on the sender. <br /></td></tr> +<tr class="separator:a214eb30b24e6831d016a47b9dddda830"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2f1d8ca25f71dff178c462cf984327f9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f1d8ca25f71dff178c462cf984327f9"></a> +class <a class="el" href="classproton_1_1source.html">source</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#a2f1d8ca25f71dff178c462cf984327f9">source</a> () const </td></tr> +<tr class="memdesc:a2f1d8ca25f71dff178c462cf984327f9"><td class="mdescLeft"> </td><td class="mdescRight">Get the source node. <br /></td></tr> +<tr class="separator:a2f1d8ca25f71dff178c462cf984327f9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a68cde95e630ce554bb4a2ba9ef087a17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a68cde95e630ce554bb4a2ba9ef087a17"></a> +class <a class="el" href="classproton_1_1target.html">target</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#a68cde95e630ce554bb4a2ba9ef087a17">target</a> () const </td></tr> +<tr class="memdesc:a68cde95e630ce554bb4a2ba9ef087a17"><td class="mdescLeft"> </td><td class="mdescRight">Get the target node. <br /></td></tr> +<tr class="separator:a68cde95e630ce554bb4a2ba9ef087a17"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abc4cb5f2f38643abb47c0b221a130bc8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#abc4cb5f2f38643abb47c0b221a130bc8">return_credit</a> ()</td></tr> +<tr class="memdesc:abc4cb5f2f38643abb47c0b221a130bc8"><td class="mdescLeft"> </td><td class="mdescRight">Return all unused credit to the receiver in response to a drain request. <a href="#abc4cb5f2f38643abb47c0b221a130bc8">More...</a><br /></td></tr> +<tr class="separator:abc4cb5f2f38643abb47c0b221a130bc8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac148c054a035b462f4483f38078374bf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac148c054a035b462f4483f38078374bf"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ac148c054a035b462f4483f38078374bf">uninitialized</a> () const </td></tr> +<tr class="memdesc:ac148c054a035b462f4483f38078374bf"><td class="mdescLeft"> </td><td class="mdescRight">True if the local end is uninitialized. <br /></td></tr> +<tr class="separator:ac148c054a035b462f4483f38078374bf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6fd1dc792a0b98e6530a7383d4ef3074"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fd1dc792a0b98e6530a7383d4ef3074"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a6fd1dc792a0b98e6530a7383d4ef3074">active</a> () const </td></tr> +<tr class="memdesc:a6fd1dc792a0b98e6530a7383d4ef3074"><td class="mdescLeft"> </td><td class="mdescRight">True if the local end is active. <br /></td></tr> +<tr class="separator:a6fd1dc792a0b98e6530a7383d4ef3074"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a24c88f59fb7d18a293dbc5e6cbebd744"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24c88f59fb7d18a293dbc5e6cbebd744"></a> +bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a24c88f59fb7d18a293dbc5e6cbebd744">closed</a> () const </td></tr> +<tr class="memdesc:a24c88f59fb7d18a293dbc5e6cbebd744"><td class="mdescLeft"> </td><td class="mdescRight">True if the local and remote ends are closed. <br /></td></tr> +<tr class="separator:a24c88f59fb7d18a293dbc5e6cbebd744"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae94b11511c3ff52ec5b4988122a232ff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae94b11511c3ff52ec5b4988122a232ff"></a> +class <a class="el" href="classproton_1_1error__condition.html">error_condition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ae94b11511c3ff52ec5b4988122a232ff">error</a> () const </td></tr> +<tr class="memdesc:ae94b11511c3ff52ec5b4988122a232ff"><td class="mdescLeft"> </td><td class="mdescRight">Get the error condition of the remote endpoint. <br /></td></tr> +<tr class="separator:ae94b11511c3ff52ec5b4988122a232ff"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr> -<tr class="memdesc:a5ae591df94fc66ccb85cbb6565368bca"><td class="mdescLeft"> </td><td class="mdescRight">Locally close the link. <a href="#a5ae591df94fc66ccb85cbb6565368bca">More...</a><br /></td></tr> +<tr class="memdesc:a5ae591df94fc66ccb85cbb6565368bca"><td class="mdescLeft"> </td><td class="mdescRight">Close the endpoint. <a href="#a5ae591df94fc66ccb85cbb6565368bca">More...</a><br /></td></tr> <tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a817883d28ce0ac8a29d917d196796f68"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a817883d28ce0ac8a29d917d196796f68">close</a> (const <a class="el" href="classproton_1_1error__condition.html">error_condition</a> &)</td></tr> +<tr class="memdesc:a817883d28ce0ac8a29d917d196796f68"><td class="mdescLeft"> </td><td class="mdescRight">Close the endpoint with an error condition. <a href="#a817883d28ce0ac8a29d917d196796f68">More...</a><br /></td></tr> +<tr class="separator:a817883d28ce0ac8a29d917d196796f68"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac295bade8aee589f6718dfa79edc2a34"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ac295bade8aee589f6718dfa79edc2a34">detach</a> ()</td></tr> <tr class="memdesc:ac295bade8aee589f6718dfa79edc2a34"><td class="mdescLeft"> </td><td class="mdescRight">Suspend the link without closing it. <a href="#ac295bade8aee589f6718dfa79edc2a34">More...</a><br /></td></tr> <tr class="separator:ac295bade8aee589f6718dfa79edc2a34"><td class="memSeparator" colspan="2"> </td></tr> @@ -166,78 +168,30 @@ const class <a class="el" href="classproton_1_1sender.html">sender</a> </td int </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a75360c7515b9f569871c5ea953286649">credit</a> () const </td></tr> <tr class="memdesc:a75360c7515b9f569871c5ea953286649"><td class="mdescLeft"> </td><td class="mdescRight">Credit available on the link. <br /></td></tr> <tr class="separator:a75360c7515b9f569871c5ea953286649"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a42add3dc24b98be816b02f7ba64737f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42add3dc24b98be816b02f7ba64737f4"></a> -int </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a42add3dc24b98be816b02f7ba64737f4">queued</a> ()</td></tr> -<tr class="memdesc:a42add3dc24b98be816b02f7ba64737f4"><td class="mdescLeft"> </td><td class="mdescRight">The number of deliveries queued on the link. <br /></td></tr> -<tr class="separator:a42add3dc24b98be816b02f7ba64737f4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2246ba119cbaa626fb423e1ba80f84c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2246ba119cbaa626fb423e1ba80f84c5"></a> -<a class="el" href="classproton_1_1terminus.html">terminus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a2246ba119cbaa626fb423e1ba80f84c5">local_source</a> () const </td></tr> -<tr class="memdesc:a2246ba119cbaa626fb423e1ba80f84c5"><td class="mdescLeft"> </td><td class="mdescRight">Local source of the link. <br /></td></tr> -<tr class="separator:a2246ba119cbaa626fb423e1ba80f84c5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1e65cc5198f2c2e57d28815f401eb7d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e65cc5198f2c2e57d28815f401eb7d9"></a> -<a class="el" href="classproton_1_1terminus.html">terminus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a1e65cc5198f2c2e57d28815f401eb7d9">local_target</a> () const </td></tr> -<tr class="memdesc:a1e65cc5198f2c2e57d28815f401eb7d9"><td class="mdescLeft"> </td><td class="mdescRight">Local target of the link. <br /></td></tr> -<tr class="separator:a1e65cc5198f2c2e57d28815f401eb7d9"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:adc8d612ee69e5722919c1bc2c95df66e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc8d612ee69e5722919c1bc2c95df66e"></a> -<a class="el" href="classproton_1_1terminus.html">terminus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#adc8d612ee69e5722919c1bc2c95df66e">remote_source</a> () const </td></tr> -<tr class="memdesc:adc8d612ee69e5722919c1bc2c95df66e"><td class="mdescLeft"> </td><td class="mdescRight">Remote source of the link. <br /></td></tr> -<tr class="separator:adc8d612ee69e5722919c1bc2c95df66e"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad5797a56dcc8453297ee6551fed06a95"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5797a56dcc8453297ee6551fed06a95"></a> -<a class="el" href="classproton_1_1terminus.html">terminus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ad5797a56dcc8453297ee6551fed06a95">remote_target</a> () const </td></tr> -<tr class="memdesc:ad5797a56dcc8453297ee6551fed06a95"><td class="mdescLeft"> </td><td class="mdescRight">Remote target of the link. <br /></td></tr> -<tr class="separator:ad5797a56dcc8453297ee6551fed06a95"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a19c36a38b50e8080b94a47230a56234f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a19c36a38b50e8080b94a47230a56234f">draining</a> ()</td></tr> +<tr class="memdesc:a19c36a38b50e8080b94a47230a56234f"><td class="mdescLeft"> </td><td class="mdescRight">True for a receiver if a drain cycle has been started and the corresponding <code>on_receiver_drain_finish</code> event is still pending. <a href="#a19c36a38b50e8080b94a47230a56234f">More...</a><br /></td></tr> +<tr class="separator:a19c36a38b50e8080b94a47230a56234f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37627d5d5bba7f4a8690c71c2ab3cb07"></a> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a37627d5d5bba7f4a8690c71c2ab3cb07">name</a> () const </td></tr> <tr class="memdesc:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="mdescLeft"> </td><td class="mdescRight">Get the link name. <br /></td></tr> <tr class="separator:a37627d5d5bba7f4a8690c71c2ab3cb07"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a604ee46e04955a2323f305b4a81017a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a604ee46e04955a2323f305b4a81017a0"></a> class <a class="el" href="classproton_1_1container.html">container</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a604ee46e04955a2323f305b4a81017a0">container</a> () const </td></tr> -<tr class="memdesc:a604ee46e04955a2323f305b4a81017a0"><td class="mdescLeft"> </td><td class="mdescRight">Return the container for this link. <br /></td></tr> +<tr class="memdesc:a604ee46e04955a2323f305b4a81017a0"><td class="mdescLeft"> </td><td class="mdescRight">The container for this link. <br /></td></tr> <tr class="separator:a604ee46e04955a2323f305b4a81017a0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af13d10fc3d843719af9ff4c456330a73"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af13d10fc3d843719af9ff4c456330a73"></a> +class <a class="el" href="classproton_1_1connection.html">connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#af13d10fc3d843719af9ff4c456330a73">connection</a> () const </td></tr> +<tr class="memdesc:af13d10fc3d843719af9ff4c456330a73"><td class="mdescLeft"> </td><td class="mdescRight">The connection that owns this link. <br /></td></tr> +<tr class="separator:af13d10fc3d843719af9ff4c456330a73"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa33faff52aea9845efaf184f86676cc5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa33faff52aea9845efaf184f86676cc5"></a> class <a class="el" href="classproton_1_1session.html">session</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#aa33faff52aea9845efaf184f86676cc5">session</a> () const </td></tr> -<tr class="memdesc:aa33faff52aea9845efaf184f86676cc5"><td class="mdescLeft"> </td><td class="mdescRight">Session that owns this link. <br /></td></tr> +<tr class="memdesc:aa33faff52aea9845efaf184f86676cc5"><td class="mdescLeft"> </td><td class="mdescRight">The session that owns this link. <br /></td></tr> <tr class="separator:aa33faff52aea9845efaf184f86676cc5"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> -Static Public Attributes</h2></td></tr> -<tr class="memitem:a84e5c2baecd6fd28505eac28ab14bacb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84e5c2baecd6fd28505eac28ab14bacb"></a> -static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#a84e5c2baecd6fd28505eac28ab14bacb">LOCAL_UNINIT</a></td></tr> -<tr class="memdesc:a84e5c2baecd6fd28505eac28ab14bacb"><td class="mdescLeft"> </td><td class="mdescRight">Local endpoint is uninitialized. <br /></td></tr> -<tr class="separator:a84e5c2baecd6fd28505eac28ab14bacb"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aca8e5dcefe432fcb32f48dc0433cf5ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca8e5dcefe432fcb32f48dc0433cf5ca"></a> -static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#aca8e5dcefe432fcb32f48dc0433cf5ca">REMOTE_UNINIT</a></td></tr> -<tr class="memdesc:aca8e5dcefe432fcb32f48dc0433cf5ca"><td class="mdescLeft"> </td><td class="mdescRight">Remote endpoint is uninitialized. <br /></td></tr> -<tr class="separator:aca8e5dcefe432fcb32f48dc0433cf5ca"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa9bb5c15062bee80022f56bffcf2868a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9bb5c15062bee80022f56bffcf2868a"></a> -static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#aa9bb5c15062bee80022f56bffcf2868a">LOCAL_ACTIVE</a></td></tr> -<tr class="memdesc:aa9bb5c15062bee80022f56bffcf2868a"><td class="mdescLeft"> </td><td class="mdescRight">Local endpoint is active. <br /></td></tr> -<tr class="separator:aa9bb5c15062bee80022f56bffcf2868a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa1f09a6f628fac670f0f92601155e155"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1f09a6f628fac670f0f92601155e155"></a> -static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#aa1f09a6f628fac670f0f92601155e155">REMOTE_ACTIVE</a></td></tr> -<tr class="memdesc:aa1f09a6f628fac670f0f92601155e155"><td class="mdescLeft"> </td><td class="mdescRight">Remote endpoint is active. <br /></td></tr> -<tr class="separator:aa1f09a6f628fac670f0f92601155e155"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a4f8d870a4ace6dd1be8728f0e3ccf23c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f8d870a4ace6dd1be8728f0e3ccf23c"></a> -static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#a4f8d870a4ace6dd1be8728f0e3ccf23c">LOCAL_CLOSED</a></td></tr> -<tr class="memdesc:a4f8d870a4ace6dd1be8728f0e3ccf23c"><td class="mdescLeft"> </td><td class="mdescRight">Local endpoint has been closed. <br /></td></tr> -<tr class="separator:a4f8d870a4ace6dd1be8728f0e3ccf23c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a37089f32d6a3324908be74116dfe6820"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37089f32d6a3324908be74116dfe6820"></a> -static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#a37089f32d6a3324908be74116dfe6820">REMOTE_CLOSED</a></td></tr> -<tr class="memdesc:a37089f32d6a3324908be74116dfe6820"><td class="mdescLeft"> </td><td class="mdescRight">Remote endpoint has been closed. <br /></td></tr> -<tr class="separator:a37089f32d6a3324908be74116dfe6820"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a5017b4c4cc25f9c0932455e13fb223d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5017b4c4cc25f9c0932455e13fb223d4"></a> -static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#a5017b4c4cc25f9c0932455e13fb223d4">LOCAL_MASK</a></td></tr> -<tr class="memdesc:a5017b4c4cc25f9c0932455e13fb223d4"><td class="mdescLeft"> </td><td class="mdescRight">Mask including all LOCAL_ bits (UNINIT, ACTIVE, CLOSED) <br /></td></tr> -<tr class="separator:a5017b4c4cc25f9c0932455e13fb223d4"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a5ee39a5f2e921db5be1c2a0e56035761"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ee39a5f2e921db5be1c2a0e56035761"></a> -static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#a5ee39a5f2e921db5be1c2a0e56035761">REMOTE_MASK</a></td></tr> -<tr class="memdesc:a5ee39a5f2e921db5be1c2a0e56035761"><td class="mdescLeft"> </td><td class="mdescRight">Mask including all REMOTE_ bits (UNINIT, ACTIVE, CLOSED) <br /></td></tr> -<tr class="separator:a5ee39a5f2e921db5be1c2a0e56035761"><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 link for sending messages. </p> -</div><h2 class="groupheader">Member Typedef Documentation</h2> -<a class="anchor" id="a9660be8f45524b15c3931fb752de3b3e"></a> +<div class="textblock"><p>A channel for sending messages. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a5ae591df94fc66ccb85cbb6565368bca"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> @@ -245,24 +199,27 @@ static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">typedef int <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c3931fb752de3b3e">state</a></td> + <td class="memname">void close </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> </tr> </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">inherited</span></span> </td> +<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> -<p>A bit mask of state bit values. </p> -<p>A state mask is matched against an endpoint as follows: If the state mask contains both local and remote flags, then an exact match against those flags is performed. If state contains only local or only remote flags, then a match occurs if any of the local or remote flags are set respectively.</p> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1connection.html#af304203ffaff9415b7884f53507b72dc" title="Return links on this connection matching the state mask. ">connection::links</a>, <a class="el" href="classproton_1_1connection.html#aa246b89acfdf85eff5e58f3fceae46dd" title="Return sessions on this connection matching the state mask. ">connection::sessions</a> </dd></dl> +<p>Close the endpoint. </p> +<dl class="section see"><dt>See also</dt><dd>endpoint_lifecycle </dd></dl> + +<p>Implements <a class="el" href="classproton_1_1endpoint.html#af6ee7eacbde6b379b68d954e44f6e549">endpoint</a>.</p> </div> </div> -<h2 class="groupheader">Member Function Documentation</h2> -<a class="anchor" id="a5ae591df94fc66ccb85cbb6565368bca"></a> +<a class="anchor" id="a817883d28ce0ac8a29d917d196796f68"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> @@ -272,19 +229,22 @@ static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c <tr> <td class="memname">void close </td> <td>(</td> + <td class="paramtype">const <a class="el" href="classproton_1_1error__condition.html">error_condition</a> & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">inherited</span></span> </td> +<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> -<p>Locally close the link. </p> -<p>The operation is not complete till handler::on_link_close. </p> +<p>Close the endpoint with an error condition. </p> +<dl class="section see"><dt>See also</dt><dd>endpoint_lifecycle </dd></dl> + +<p>Implements <a class="el" href="classproton_1_1endpoint.html#ad4fcddcba5b74ba7766ac6f125469644">endpoint</a>.</p> </div> </div> @@ -310,11 +270,11 @@ static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c </div><div class="memdoc"> <p>Suspend the link without closing it. </p> -<p>A suspended link may be reopened with the same or different link options if supported by the peer. A suspended durable subscriptions becomes inactive without cancelling it. </p> +<p>A suspended link may be reopened with the same or different link options if supported by the peer. A suspended durable subscription becomes inactive without cancelling it. </p> </div> </div> -<a class="anchor" id="aaaea8dc733566e78a066d2435f8a60c5"></a> +<a class="anchor" id="a19c36a38b50e8080b94a47230a56234f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> @@ -322,50 +282,78 @@ static const <a class="el" href="classproton_1_1endpoint.html#a9660be8f45524b15c <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classproton_1_1condition.html">condition</a> local_condition </td> + <td class="memname">bool draining </td> <td>(</td> <td class="paramname"></td><td>)</td> - <td> const</td> + <td></td> </tr> </table> </td> <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">inherited</span></span> </td> +<span class="mlabels"><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> -<p>XXX add endpoint state boolean operations. </p> -<p>Get the local error condition. </p> +<p>True for a receiver if a drain cycle has been started and the corresponding <code>on_receiver_drain_finish</code> event is still pending. </p> +<p>True for a sender if the receiver has requested a drain of credit and the sender has unused credit.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1receiver.html#af7d01b5776b9d8a0f218aec331ddaeb9">receiver::drain</a>. </dd></dl> -<p>Implements <a class="el" href="classproton_1_1endpoint.html#a8e6552f9fc799927204b763969513099">endpoint</a>.</p> +</div> +</div> +<a class="anchor" id="a9e8555112049fc2b4945120b3c45f8ab"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void open </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Open the sender. </p> +<dl class="section see"><dt>See also</dt><dd>endpoint_lifecycle </dd></dl> </div> </div> -<a class="anchor" id="afdfda4724950dfecdbc2e74b6a888998"></a> +<a class="anchor" id="a0177dfbb87c4a94379c4ab6ac77a134e"></a> <div class="memitem"> <div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void open </td> <td>(</td> - <td class="paramtype">const <a class="el" href="classproton_1_1link__options.html">link_options</a> & </td> - <td class="paramname"><em>opts</em> = <code><a class="el" href="classproton_1_1link__options.html">link_options</a>()</code></td><td>)</td> + <td class="paramtype">const <a class="el" href="classproton_1_1sender__options.html">sender_options</a> & </td> + <td class="paramname"><em>opts</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Open the sender. </p> +<dl class="section see"><dt>See also</dt><dd>endpoint_lifecycle </dd></dl> + +</div> +</div> +<a class="anchor" id="abc4cb5f2f38643abb47c0b221a130bc8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void return_credit </td> + <td>(</td> + <td class="paramname"></td><td>)</td> <td></td> </tr> </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">inherited</span></span> </td> - </tr> -</table> </div><div class="memdoc"> -<p>Locally open the link. </p> -<p>The operation is not complete till handler::on_link_open. </p> +<p>Return all unused credit to the receiver in response to a drain request. </p> +<p>Has no effect unless there has been a drain request and there is remaining credit to use or return.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1receiver.html#af7d01b5776b9d8a0f218aec331ddaeb9" title="Commence a drain cycle. ">receiver::drain</a> </dd></dl> </div> </div> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org