Google Git
Sign in
apache / qpid-site / 04beb6e78eda47fdfc2fcfc1d2eeb9a270f89a87 / . / content / releases / qpid-proton-0.32.0 / proton / cpp / api / classproton_1_1sender.html
blob: 0a0fc1d5bdd5180c5e09580d0e4d0956305bb161 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C++ API: sender</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Qpid Proton C++ API
&#160;<span id="projectnumber">0.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classproton_1_1sender.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="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 channel for sending messages.
<a href="classproton_1_1sender.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="sender_8hpp_source.html">sender.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sender:</div>
<div class="dyncontent">
<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="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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae8473244d5665777c846fa88eba39252"><td class="memItemLeft" align="right" valign="top"><a id="ae8473244d5665777c846fa88eba39252"></a>
&#160;</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">&#160;</td><td class="mdescRight">Create an empty sender. <br /></td></tr>
<tr class="separator:ae8473244d5665777c846fa88eba39252"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e8555112049fc2b4945120b3c45f8ab"><td class="memItemLeft" align="right" valign="top"><a id="a9e8555112049fc2b4945120b3c45f8ab"></a>
void&#160;</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">&#160;</td><td class="mdescRight">Open the sender. <br /></td></tr>
<tr class="separator:a9e8555112049fc2b4945120b3c45f8ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0177dfbb87c4a94379c4ab6ac77a134e"><td class="memItemLeft" align="right" valign="top">void&#160;</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> &amp;opts)</td></tr>
<tr class="memdesc:a0177dfbb87c4a94379c4ab6ac77a134e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the sender. <a href="classproton_1_1sender.html#a0177dfbb87c4a94379c4ab6ac77a134e">More...</a><br /></td></tr>
<tr class="separator:a0177dfbb87c4a94379c4ab6ac77a134e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a214eb30b24e6831d016a47b9dddda830"><td class="memItemLeft" align="right" valign="top"><a id="a214eb30b24e6831d016a47b9dddda830"></a>
<a class="el" href="classproton_1_1tracker.html">tracker</a>&#160;</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> &amp;m)</td></tr>
<tr class="memdesc:a214eb30b24e6831d016a47b9dddda830"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a message on the sender. <br /></td></tr>
<tr class="separator:a214eb30b24e6831d016a47b9dddda830"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91a9e8a9445b29d83dd0514cd76503ae"><td class="memItemLeft" align="right" valign="top"><a id="a91a9e8a9445b29d83dd0514cd76503ae"></a>
class <a class="el" href="classproton_1_1source.html">source</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#a91a9e8a9445b29d83dd0514cd76503ae">source</a> () const</td></tr>
<tr class="memdesc:a91a9e8a9445b29d83dd0514cd76503ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the source node. <br /></td></tr>
<tr class="separator:a91a9e8a9445b29d83dd0514cd76503ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f0b815f331997411a6794f8628592ba"><td class="memItemLeft" align="right" valign="top"><a id="a5f0b815f331997411a6794f8628592ba"></a>
class <a class="el" href="classproton_1_1target.html">target</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1sender.html#a5f0b815f331997411a6794f8628592ba">target</a> () const</td></tr>
<tr class="memdesc:a5f0b815f331997411a6794f8628592ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the target node. <br /></td></tr>
<tr class="separator:a5f0b815f331997411a6794f8628592ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc4cb5f2f38643abb47c0b221a130bc8"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td><td class="mdescRight"><b>Unsettled API</b> - Return all unused credit to the receiver in response to a drain request. <a href="classproton_1_1sender.html#abc4cb5f2f38643abb47c0b221a130bc8">More...</a><br /></td></tr>
<tr class="separator:abc4cb5f2f38643abb47c0b221a130bc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classproton_1_1link"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classproton_1_1link')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classproton_1_1link.html">link</a></td></tr>
<tr class="memitem:ad29b379b3621ec393ac9f28b4ba8b010 inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="ad29b379b3621ec393ac9f28b4ba8b010"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ad29b379b3621ec393ac9f28b4ba8b010">link</a> ()</td></tr>
<tr class="memdesc:ad29b379b3621ec393ac9f28b4ba8b010 inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty link. <br /></td></tr>
<tr class="separator:ad29b379b3621ec393ac9f28b4ba8b010 inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab51c3843057c4c187574e2d44839f815 inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="ab51c3843057c4c187574e2d44839f815"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ab51c3843057c4c187574e2d44839f815">uninitialized</a> () const</td></tr>
<tr class="memdesc:ab51c3843057c4c187574e2d44839f815 inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the local end is uninitialized. <br /></td></tr>
<tr class="separator:ab51c3843057c4c187574e2d44839f815 inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9735e23cb0888fb98e1c5893aecff7e inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="ad9735e23cb0888fb98e1c5893aecff7e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ad9735e23cb0888fb98e1c5893aecff7e">active</a> () const</td></tr>
<tr class="memdesc:ad9735e23cb0888fb98e1c5893aecff7e inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the local end is active. <br /></td></tr>
<tr class="separator:ad9735e23cb0888fb98e1c5893aecff7e inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae54500202b0333927a28c440c85cf07e inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="ae54500202b0333927a28c440c85cf07e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ae54500202b0333927a28c440c85cf07e">closed</a> () const</td></tr>
<tr class="memdesc:ae54500202b0333927a28c440c85cf07e inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the local and remote ends are closed. <br /></td></tr>
<tr class="separator:ae54500202b0333927a28c440c85cf07e inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a090a10fab22d7faf0f74c8ccda0f1470 inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="a090a10fab22d7faf0f74c8ccda0f1470"></a>
class <a class="el" href="classproton_1_1error__condition.html">error_condition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a090a10fab22d7faf0f74c8ccda0f1470">error</a> () const</td></tr>
<tr class="memdesc:a090a10fab22d7faf0f74c8ccda0f1470 inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the error condition of the remote endpoint. <br /></td></tr>
<tr class="separator:a090a10fab22d7faf0f74c8ccda0f1470 inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ae591df94fc66ccb85cbb6565368bca inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="a5ae591df94fc66ccb85cbb6565368bca"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
<tr class="memdesc:a5ae591df94fc66ccb85cbb6565368bca inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the endpoint. <br /></td></tr>
<tr class="separator:a5ae591df94fc66ccb85cbb6565368bca inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a817883d28ce0ac8a29d917d196796f68 inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="a817883d28ce0ac8a29d917d196796f68"></a>
void&#160;</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> &amp;)</td></tr>
<tr class="memdesc:a817883d28ce0ac8a29d917d196796f68 inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the endpoint with an error condition. <br /></td></tr>
<tr class="separator:a817883d28ce0ac8a29d917d196796f68 inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac295bade8aee589f6718dfa79edc2a34 inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ac295bade8aee589f6718dfa79edc2a34">detach</a> ()</td></tr>
<tr class="memdesc:ac295bade8aee589f6718dfa79edc2a34 inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suspend the link without closing it. <a href="classproton_1_1link.html#ac295bade8aee589f6718dfa79edc2a34">More...</a><br /></td></tr>
<tr class="separator:ac295bade8aee589f6718dfa79edc2a34 inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd27bd11ba72d7df51c44f71b15749eb inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="afd27bd11ba72d7df51c44f71b15749eb"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#afd27bd11ba72d7df51c44f71b15749eb">credit</a> () const</td></tr>
<tr class="memdesc:afd27bd11ba72d7df51c44f71b15749eb inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">Credit available on the link. <br /></td></tr>
<tr class="separator:afd27bd11ba72d7df51c44f71b15749eb inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19c36a38b50e8080b94a47230a56234f inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a19c36a38b50e8080b94a47230a56234f">draining</a> ()</td></tr>
<tr class="memdesc:a19c36a38b50e8080b94a47230a56234f inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>Unsettled API</b> - 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="classproton_1_1link.html#a19c36a38b50e8080b94a47230a56234f">More...</a><br /></td></tr>
<tr class="separator:a19c36a38b50e8080b94a47230a56234f inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="a1d89c28bd42ba9a52da008bb69367171"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a1d89c28bd42ba9a52da008bb69367171">name</a> () const</td></tr>
<tr class="memdesc:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the link name. <br /></td></tr>
<tr class="separator:a1d89c28bd42ba9a52da008bb69367171 inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f632b80247e868b8264b8a025b84baf inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="a2f632b80247e868b8264b8a025b84baf"></a>
class <a class="el" href="classproton_1_1container.html">container</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a2f632b80247e868b8264b8a025b84baf">container</a> () const</td></tr>
<tr class="memdesc:a2f632b80247e868b8264b8a025b84baf inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">The container for this link. <br /></td></tr>
<tr class="separator:a2f632b80247e868b8264b8a025b84baf inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c755d6ac6385e007adb61966598ba63 inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="a7c755d6ac6385e007adb61966598ba63"></a>
class <a class="el" href="classproton_1_1work__queue.html">work_queue</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#a7c755d6ac6385e007adb61966598ba63">work_queue</a> () const</td></tr>
<tr class="memdesc:a7c755d6ac6385e007adb61966598ba63 inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="classproton_1_1work__queue.html" title="Unsettled API - A context for thread-safe execution of work.">work_queue</a> for the link. <br /></td></tr>
<tr class="separator:a7c755d6ac6385e007adb61966598ba63 inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff302bb6016f2ae29f01bb4e07389a52 inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="aff302bb6016f2ae29f01bb4e07389a52"></a>
class <a class="el" href="classproton_1_1connection.html">connection</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#aff302bb6016f2ae29f01bb4e07389a52">connection</a> () const</td></tr>
<tr class="memdesc:aff302bb6016f2ae29f01bb4e07389a52 inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">The connection that owns this link. <br /></td></tr>
<tr class="separator:aff302bb6016f2ae29f01bb4e07389a52 inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab55cf76248b8b6e571a869c407ba39e6 inherit pub_methods_classproton_1_1link"><td class="memItemLeft" align="right" valign="top"><a id="ab55cf76248b8b6e571a869c407ba39e6"></a>
class <a class="el" href="classproton_1_1session.html">session</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1link.html#ab55cf76248b8b6e571a869c407ba39e6">session</a> () const</td></tr>
<tr class="memdesc:ab55cf76248b8b6e571a869c407ba39e6 inherit pub_methods_classproton_1_1link"><td class="mdescLeft">&#160;</td><td class="mdescRight">The session that owns this link. <br /></td></tr>
<tr class="separator:ab55cf76248b8b6e571a869c407ba39e6 inherit pub_methods_classproton_1_1link"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A channel for sending messages. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8cpp-example.html#_a1">broker.cpp</a>, <a class="el" href="client_8cpp-example.html#_a3">client.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#_a8">direct_send.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#_a9">helloworld.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#_a1">multithreaded_client.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#_a1">multithreaded_client_flow_control.cpp</a>, <a class="el" href="scheduled_send_8cpp-example.html#_a1">scheduled_send.cpp</a>, <a class="el" href="scheduled_send_03_8cpp-example.html#_a8">scheduled_send_03.cpp</a>, <a class="el" href="server_direct_8cpp-example.html#_a8">server_direct.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#_a29">service_bus.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#_a1">simple_send.cpp</a>.</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a0177dfbb87c4a94379c4ab6ac77a134e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0177dfbb87c4a94379c4ab6ac77a134e">&#9670;&nbsp;</a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void open </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classproton_1_1sender__options.html">sender_options</a> &amp;&#160;</td>
<td class="paramname"><em>opts</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the sender. </p>
</div>
</div>
<a id="abc4cb5f2f38643abb47c0b221a130bc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc4cb5f2f38643abb47c0b221a130bc8">&#9670;&nbsp;</a></span>return_credit()</h2>
<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>
</div><div class="memdoc">
<p><b>Unsettled API</b> - 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="Unsettled API - Commence a drain cycle.">receiver::drain</a> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>proton/<a class="el" href="sender_8hpp_source.html">sender.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_1sender.html">sender</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>