http://git-wip-us.apache.org/repos/asf/qpid-site/blob/c3ab60f6/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.html b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.html new file mode 100755 index 0000000..ca89320 --- /dev/null +++ b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.html @@ -0,0 +1,469 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Qpid C++ Messaging API: qpid::messaging::Receiver Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</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 C++ Messaging API +  <span id="projectnumber">1.39.0</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.13 --> +<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('classqpid_1_1messaging_1_1Receiver.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="#friends">Friends</a> | +<a href="classqpid_1_1messaging_1_1Receiver-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">qpid::messaging::Receiver Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="Receiver_8h_source.html">Receiver.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for qpid::messaging::Receiver:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classqpid_1_1messaging_1_1Receiver.png" usemap="#qpid::messaging::Receiver_map" alt=""/> + <map id="qpid::messaging::Receiver_map" name="qpid::messaging::Receiver_map"> +<area href="classqpid_1_1messaging_1_1Handle.html" alt="qpid::messaging::Handle< ReceiverImpl >" shape="rect" coords="0,0,243,24"/> +</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:a978077c57adaf9823956c9d8209cd326"><td class="memItemLeft" align="right" valign="top"><a id="a978077c57adaf9823956c9d8209cd326"></a> +QPID_MESSAGING_EXTERN </td><td class="memItemRight" valign="bottom"><b>Receiver</b> (ReceiverImpl *impl=0)</td></tr> +<tr class="separator:a978077c57adaf9823956c9d8209cd326"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3cb0c1162fef8db3d2c9221f4510534d"><td class="memItemLeft" align="right" valign="top"><a id="a3cb0c1162fef8db3d2c9221f4510534d"></a> +QPID_MESSAGING_EXTERN </td><td class="memItemRight" valign="bottom"><b>Receiver</b> (const <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a> &)</td></tr> +<tr class="separator:a3cb0c1162fef8db3d2c9221f4510534d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad0be7017fc2012b6db56f72ae34bccd6"><td class="memItemLeft" align="right" valign="top"><a id="ad0be7017fc2012b6db56f72ae34bccd6"></a> +QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a> &)</td></tr> +<tr class="separator:ad0be7017fc2012b6db56f72ae34bccd6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af60ff3ff2a71728b191bbfc656ccba93"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#af60ff3ff2a71728b191bbfc656ccba93">get</a> (<a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> &message, <a class="el" href="classqpid_1_1messaging_1_1Duration.html">Duration</a> timeout=Duration::FOREVER)</td></tr> +<tr class="separator:af60ff3ff2a71728b191bbfc656ccba93"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a31f17a5b1c0d250f319c5e82a5cdb8e9"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#a31f17a5b1c0d250f319c5e82a5cdb8e9">get</a> (<a class="el" href="classqpid_1_1messaging_1_1Duration.html">Duration</a> timeout=Duration::FOREVER)</td></tr> +<tr class="separator:a31f17a5b1c0d250f319c5e82a5cdb8e9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa3b46a16b002054cd73f9c625ff496bb"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#aa3b46a16b002054cd73f9c625ff496bb">fetch</a> (<a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> &message, <a class="el" href="classqpid_1_1messaging_1_1Duration.html">Duration</a> timeout=Duration::FOREVER)</td></tr> +<tr class="separator:aa3b46a16b002054cd73f9c625ff496bb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaa7226095a43c3dda3f1e709b21e7ab2"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#aaa7226095a43c3dda3f1e709b21e7ab2">fetch</a> (<a class="el" href="classqpid_1_1messaging_1_1Duration.html">Duration</a> timeout=Duration::FOREVER)</td></tr> +<tr class="separator:aaa7226095a43c3dda3f1e709b21e7ab2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abc79d61aa781451f60a9b689ae4aa66f"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#abc79d61aa781451f60a9b689ae4aa66f">setCapacity</a> (uint32_t)</td></tr> +<tr class="separator:abc79d61aa781451f60a9b689ae4aa66f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a66ec1eaf8e6bd407eab5f079e3eb0d59"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#a66ec1eaf8e6bd407eab5f079e3eb0d59">getCapacity</a> ()</td></tr> +<tr class="separator:a66ec1eaf8e6bd407eab5f079e3eb0d59"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7722e100c8a1908d873a60d250d30b27"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#a7722e100c8a1908d873a60d250d30b27">getAvailable</a> ()</td></tr> +<tr class="separator:a7722e100c8a1908d873a60d250d30b27"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a07974fffa1cb5ace0c85a6c4242ff79e"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#a07974fffa1cb5ace0c85a6c4242ff79e">getUnsettled</a> ()</td></tr> +<tr class="separator:a07974fffa1cb5ace0c85a6c4242ff79e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5f9e4b67b32ed49aa795011f53938b8e"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#a5f9e4b67b32ed49aa795011f53938b8e">close</a> ()</td></tr> +<tr class="separator:a5f9e4b67b32ed49aa795011f53938b8e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae0572d8517f88082049f691a8a21c677"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#ae0572d8517f88082049f691a8a21c677">isClosed</a> () const</td></tr> +<tr class="separator:ae0572d8517f88082049f691a8a21c677"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5fbc5dd2b1456646f04295017af7f1b2"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#a5fbc5dd2b1456646f04295017af7f1b2">getName</a> () const</td></tr> +<tr class="separator:a5fbc5dd2b1456646f04295017af7f1b2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4397dc401283c352f8aa325d60c074bc"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Session.html">Session</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#a4397dc401283c352f8aa325d60c074bc">getSession</a> () const</td></tr> +<tr class="separator:a4397dc401283c352f8aa325d60c074bc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1e96a2068161527e0a7c61563e73f359"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Address.html">Address</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html#a1e96a2068161527e0a7c61563e73f359">getAddress</a> () const</td></tr> +<tr class="separator:a1e96a2068161527e0a7c61563e73f359"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classqpid_1_1messaging_1_1Handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classqpid_1_1messaging_1_1Handle')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< ReceiverImpl ></a></td></tr> +<tr class="memitem:abdfd2c1acc987f8028a671066a8d6a47 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_INLINE_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#abdfd2c1acc987f8028a671066a8d6a47">isValid</a> () const</td></tr> +<tr class="separator:abdfd2c1acc987f8028a671066a8d6a47 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a484818fd643933443d8a2fda3ad1f9b3 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_INLINE_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#a484818fd643933443d8a2fda3ad1f9b3">isNull</a> () const</td></tr> +<tr class="separator:a484818fd643933443d8a2fda3ad1f9b3 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab7b5bd2c70cfdeeaa7a87d6713f26dfd inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_INLINE_EXTERN </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#ab7b5bd2c70cfdeeaa7a87d6713f26dfd">operator bool</a> () const</td></tr> +<tr class="separator:ab7b5bd2c70cfdeeaa7a87d6713f26dfd inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5ebf515ed24d99a08e368e1c3c61b042 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_INLINE_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#a5ebf515ed24d99a08e368e1c3c61b042">operator!</a> () const</td></tr> +<tr class="separator:a5ebf515ed24d99a08e368e1c3c61b042 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a65237851b8de03d0a366f5e02c3ca5c4 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a65237851b8de03d0a366f5e02c3ca5c4"></a> +void </td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="classqpid_1_1messaging_1_1Handle.html">Handle</a>< ReceiverImpl > &h)</td></tr> +<tr class="separator:a65237851b8de03d0a366f5e02c3ca5c4 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> +Friends</h2></td></tr> +<tr class="memitem:a76f44c010d09ee3eb5566cc61382dc8c"><td class="memItemLeft" align="right" valign="top"><a id="a76f44c010d09ee3eb5566cc61382dc8c"></a> +class </td><td class="memItemRight" valign="bottom"><b>qpid::messaging::PrivateImplRef< Receiver ></b></td></tr> +<tr class="separator:a76f44c010d09ee3eb5566cc61382dc8c"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pro_types_classqpid_1_1messaging_1_1Handle"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classqpid_1_1messaging_1_1Handle')"><img src="closed.png" alt="-"/> Protected Types inherited from <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< ReceiverImpl ></a></td></tr> +<tr class="memitem:aae44d218cffcb40859af8702e4635d3f inherit pro_types_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="aae44d218cffcb40859af8702e4635d3f"></a> +typedef ReceiverImpl </td><td class="memItemRight" valign="bottom"><b>Impl</b></td></tr> +<tr class="separator:aae44d218cffcb40859af8702e4635d3f inherit pro_types_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pro_attribs_classqpid_1_1messaging_1_1Handle"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classqpid_1_1messaging_1_1Handle')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< ReceiverImpl ></a></td></tr> +<tr class="memitem:a56e6095295d9b798d9df9f4c53e80e32 inherit pro_attribs_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a56e6095295d9b798d9df9f4c53e80e32"></a> +Impl * </td><td class="memItemRight" valign="bottom"><b>impl</b></td></tr> +<tr class="separator:a56e6095295d9b798d9df9f4c53e80e32 inherit pro_attribs_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Interface through which messages are received. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a5f9e4b67b32ed49aa795011f53938b8e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5f9e4b67b32ed49aa795011f53938b8e">◆ </a></span>close()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN void qpid::messaging::Receiver::close </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Cancels this <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>. </p> + +</div> +</div> +<a id="aa3b46a16b002054cd73f9c625ff496bb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa3b46a16b002054cd73f9c625ff496bb">◆ </a></span>fetch() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN bool qpid::messaging::Receiver::fetch </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> & </td> + <td class="paramname"><em>message</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classqpid_1_1messaging_1_1Duration.html">Duration</a> </td> + <td class="paramname"><em>timeout</em> = <code>Duration::FOREVER</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Retrieves a message from this <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>'s subscription or waits for up to the specified timeout for one to become available. Unlike <a class="el" href="classqpid_1_1messaging_1_1Receiver.html#af60ff3ff2a71728b191bbfc656ccba93">get()</a>, this method will check with the server that there is no message for the subscription this receiver is serving before returning false.</p> +<dl class="section return"><dt>Returns</dt><dd>false if there is no message available after waiting for the specified time period, or if the receiver is closed, in which case <a class="el" href="classqpid_1_1messaging_1_1Receiver.html#ae0572d8517f88082049f691a8a21c677">isClosed()</a> will be true. </dd></dl> + +</div> +</div> +<a id="aaa7226095a43c3dda3f1e709b21e7ab2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aaa7226095a43c3dda3f1e709b21e7ab2">◆ </a></span>fetch() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> qpid::messaging::Receiver::fetch </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classqpid_1_1messaging_1_1Duration.html">Duration</a> </td> + <td class="paramname"><em>timeout</em> = <code>Duration::FOREVER</code></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Retrieves a message for this <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>'s subscription or waits for up to the specified timeout for one to become available. Unlike <a class="el" href="classqpid_1_1messaging_1_1Receiver.html#af60ff3ff2a71728b191bbfc656ccba93">get()</a>, this method will check with the server that there is no message for the subscription this receiver is serving before throwing an exception.</p> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="structqpid_1_1messaging_1_1NoMessageAvailable.html">NoMessageAvailable</a></td><td>if there is no message available after waiting for the specified timeout, or if the <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a> is closed, in which case isClose() will be true. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="af60ff3ff2a71728b191bbfc656ccba93"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af60ff3ff2a71728b191bbfc656ccba93">◆ </a></span>get() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN bool qpid::messaging::Receiver::get </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> & </td> + <td class="paramname"><em>message</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classqpid_1_1messaging_1_1Duration.html">Duration</a> </td> + <td class="paramname"><em>timeout</em> = <code>Duration::FOREVER</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Retrieves a message from this <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>'s local queue or waits for up to the specified timeout for a message to become available. </p> + +</div> +</div> +<a id="a31f17a5b1c0d250f319c5e82a5cdb8e9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a31f17a5b1c0d250f319c5e82a5cdb8e9">◆ </a></span>get() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> qpid::messaging::Receiver::get </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classqpid_1_1messaging_1_1Duration.html">Duration</a> </td> + <td class="paramname"><em>timeout</em> = <code>Duration::FOREVER</code></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Retrieves a message from this <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>'s local queue or waits for up to the specified timeout for a message to become available.</p> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname"><a class="el" href="structqpid_1_1messaging_1_1NoMessageAvailable.html">NoMessageAvailable</a></td><td>if there is no message to give after waiting for the specified timeout, or if the <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a> is closed, in which case <a class="el" href="classqpid_1_1messaging_1_1Receiver.html#ae0572d8517f88082049f691a8a21c677">isClosed()</a> will be true. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a1e96a2068161527e0a7c61563e73f359"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1e96a2068161527e0a7c61563e73f359">◆ </a></span>getAddress()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Address.html">Address</a> qpid::messaging::Receiver::getAddress </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns an address for this <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>. </p> + +</div> +</div> +<a id="a7722e100c8a1908d873a60d250d30b27"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7722e100c8a1908d873a60d250d30b27">◆ </a></span>getAvailable()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN uint32_t qpid::messaging::Receiver::getAvailable </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the number of messages received and waiting to be fetched. </dd></dl> + +</div> +</div> +<a id="a66ec1eaf8e6bd407eab5f079e3eb0d59"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a66ec1eaf8e6bd407eab5f079e3eb0d59">◆ </a></span>getCapacity()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN uint32_t qpid::messaging::Receiver::getCapacity </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the capacity of the <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>. The capacity determines how many incoming messages can be held in the <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a> before being requested by a client via <a class="el" href="classqpid_1_1messaging_1_1Receiver.html#aa3b46a16b002054cd73f9c625ff496bb">fetch()</a> (or pushed to a listener). </dd></dl> + +</div> +</div> +<a id="a5fbc5dd2b1456646f04295017af7f1b2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5fbc5dd2b1456646f04295017af7f1b2">◆ </a></span>getName()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN const std::string& qpid::messaging::Receiver::getName </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns the name of this <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>. </p> + +</div> +</div> +<a id="a4397dc401283c352f8aa325d60c074bc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4397dc401283c352f8aa325d60c074bc">◆ </a></span>getSession()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Session.html">Session</a> qpid::messaging::Receiver::getSession </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns a handle to the session associated with this <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>. </p> + +</div> +</div> +<a id="a07974fffa1cb5ace0c85a6c4242ff79e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a07974fffa1cb5ace0c85a6c4242ff79e">◆ </a></span>getUnsettled()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN uint32_t qpid::messaging::Receiver::getUnsettled </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="section return"><dt>Returns</dt><dd>the number of messages received on this <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a> that have been acknowledged, but for which that acknowledgement has not yet been confirmed as processed by the server. </dd></dl> + +</div> +</div> +<a id="ae0572d8517f88082049f691a8a21c677"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae0572d8517f88082049f691a8a21c677">◆ </a></span>isClosed()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN bool qpid::messaging::Receiver::isClosed </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Return true if the <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a> was closed by a call to <a class="el" href="classqpid_1_1messaging_1_1Receiver.html#a5f9e4b67b32ed49aa795011f53938b8e">close()</a>. </p> + +</div> +</div> +<a id="abc79d61aa781451f60a9b689ae4aa66f"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abc79d61aa781451f60a9b689ae4aa66f">◆ </a></span>setCapacity()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN void qpid::messaging::Receiver::setCapacity </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Sets the capacity for the <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a>. The capacity determines how many incoming messages can be held in the <a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</a> before being requested by a client via <a class="el" href="classqpid_1_1messaging_1_1Receiver.html#aa3b46a16b002054cd73f9c625ff496bb">fetch()</a> (or pushed to a listener). </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>qpid/messaging/<a class="el" href="Receiver_8h_source.html">Receiver.h</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"><b>qpid</b></li><li class="navelem"><b>messaging</b></li><li class="navelem"><a class="el" href="classqpid_1_1messaging_1_1Receiver.html">Receiver</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.13 </li> + </ul> +</div> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/c3ab60f6/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.js b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.js new file mode 100755 index 0000000..dbdf730 --- /dev/null +++ b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.js @@ -0,0 +1,21 @@ +var classqpid_1_1messaging_1_1Receiver = +[ + [ "Receiver", "classqpid_1_1messaging_1_1Receiver.html#a978077c57adaf9823956c9d8209cd326", null ], + [ "Receiver", "classqpid_1_1messaging_1_1Receiver.html#a3cb0c1162fef8db3d2c9221f4510534d", null ], + [ "~Receiver", "classqpid_1_1messaging_1_1Receiver.html#a5530b779a0a947cdae2ee9b25bf7958e", null ], + [ "close", "classqpid_1_1messaging_1_1Receiver.html#a5f9e4b67b32ed49aa795011f53938b8e", null ], + [ "fetch", "classqpid_1_1messaging_1_1Receiver.html#aa3b46a16b002054cd73f9c625ff496bb", null ], + [ "fetch", "classqpid_1_1messaging_1_1Receiver.html#aaa7226095a43c3dda3f1e709b21e7ab2", null ], + [ "get", "classqpid_1_1messaging_1_1Receiver.html#af60ff3ff2a71728b191bbfc656ccba93", null ], + [ "get", "classqpid_1_1messaging_1_1Receiver.html#a31f17a5b1c0d250f319c5e82a5cdb8e9", null ], + [ "getAddress", "classqpid_1_1messaging_1_1Receiver.html#a1e96a2068161527e0a7c61563e73f359", null ], + [ "getAvailable", "classqpid_1_1messaging_1_1Receiver.html#a7722e100c8a1908d873a60d250d30b27", null ], + [ "getCapacity", "classqpid_1_1messaging_1_1Receiver.html#a66ec1eaf8e6bd407eab5f079e3eb0d59", null ], + [ "getName", "classqpid_1_1messaging_1_1Receiver.html#a5fbc5dd2b1456646f04295017af7f1b2", null ], + [ "getSession", "classqpid_1_1messaging_1_1Receiver.html#a4397dc401283c352f8aa325d60c074bc", null ], + [ "getUnsettled", "classqpid_1_1messaging_1_1Receiver.html#a07974fffa1cb5ace0c85a6c4242ff79e", null ], + [ "isClosed", "classqpid_1_1messaging_1_1Receiver.html#ae0572d8517f88082049f691a8a21c677", null ], + [ "operator=", "classqpid_1_1messaging_1_1Receiver.html#ad0be7017fc2012b6db56f72ae34bccd6", null ], + [ "setCapacity", "classqpid_1_1messaging_1_1Receiver.html#abc79d61aa781451f60a9b689ae4aa66f", null ], + [ "qpid::messaging::PrivateImplRef< Receiver >", "classqpid_1_1messaging_1_1Receiver.html#a76f44c010d09ee3eb5566cc61382dc8c", null ] +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/c3ab60f6/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.png ---------------------------------------------------------------------- diff --git a/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.png b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.png new file mode 100755 index 0000000..010b28e Binary files /dev/null and b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Receiver.png differ http://git-wip-us.apache.org/repos/asf/qpid-site/blob/c3ab60f6/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender-members.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender-members.html b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender-members.html new file mode 100755 index 0000000..c899165 --- /dev/null +++ b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender-members.html @@ -0,0 +1,132 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Qpid C++ Messaging API: Member List</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); +</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 C++ Messaging API +  <span id="projectnumber">1.39.0</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.13 --> +<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('classqpid_1_1messaging_1_1Sender.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="headertitle"> +<div class="title">qpid::messaging::Sender Member List</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This is the complete list of members for <a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a>, including all inherited members.</p> +<table class="directory"> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>close</b>() (defined in <a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#a53e25e4f4275ac9e3ca23d5ba442e6e8">getAddress</a>() const</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#a2aaec7fcb5362df5f5c3c63acaf61c21">getAvailable</a>()</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#ae23edfc07ba612172c314b044f1e7dcc">getCapacity</a>()</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#aefd663292892953f615dca87b10a4be1">getName</a>() const</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#af7b50f2dbbd0887da8059416bbe4e823">getSession</a>() const</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#a1dd1f41ed7b5fcb2c8049692e865f049">getUnsettled</a>()</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Handle</b>() (defined in <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Impl</b> typedef (defined in <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>impl</b> (defined in <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td><td class="entry"><span class="mlabel">protected</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#a484818fd643933443d8a2fda3ad1f9b3">isNull</a>() const</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#abdfd2c1acc987f8028a671066a8d6a47">isValid</a>() const</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#ab7b5bd2c70cfdeeaa7a87d6713f26dfd">operator bool</a>() const</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#a5ebf515ed24d99a08e368e1c3c61b042">operator!</a>() const</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>operator=</b>(const Sender &) (defined in <a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>qpid::messaging::PrivateImplRef< Sender ></b> (defined in <a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"><span class="mlabel">friend</span></td></tr> + <tr class="even"><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#adedcff9ec995b301479d395f995736a9">send</a>(const Message &message, bool sync=false)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>Sender</b>(SenderImpl *impl=0) (defined in <a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>Sender</b>(const Sender &) (defined in <a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#a93ade0badc46bb1a9f5662579145e4ce">setCapacity</a>(uint32_t)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> + <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>swap</b>(Handle< SenderImpl > &h) (defined in <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td><td class="entry"><span class="mlabel">inline</span></td></tr> + <tr bgcolor="#f0f0f0"><td class="entry"><b>~Sender</b>() (defined in <a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a>)</td><td class="entry"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">qpid::messaging::Sender</a></td><td class="entry"></td></tr> +</table></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/c3ab60f6/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.html b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.html new file mode 100755 index 0000000..885a2d7 --- /dev/null +++ b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.html @@ -0,0 +1,353 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Qpid C++ Messaging API: qpid::messaging::Sender Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</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 C++ Messaging API +  <span id="projectnumber">1.39.0</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.13 --> +<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('classqpid_1_1messaging_1_1Sender.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="#friends">Friends</a> | +<a href="classqpid_1_1messaging_1_1Sender-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">qpid::messaging::Sender Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="Sender_8h_source.html">Sender.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for qpid::messaging::Sender:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classqpid_1_1messaging_1_1Sender.png" usemap="#qpid::messaging::Sender_map" alt=""/> + <map id="qpid::messaging::Sender_map" name="qpid::messaging::Sender_map"> +<area href="classqpid_1_1messaging_1_1Handle.html" alt="qpid::messaging::Handle< SenderImpl >" shape="rect" coords="0,0,233,24"/> +</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:a89456a418e984a42c7efb656478ff3ca"><td class="memItemLeft" align="right" valign="top"><a id="a89456a418e984a42c7efb656478ff3ca"></a> +QPID_MESSAGING_EXTERN </td><td class="memItemRight" valign="bottom"><b>Sender</b> (SenderImpl *impl=0)</td></tr> +<tr class="separator:a89456a418e984a42c7efb656478ff3ca"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad64423c55a30920abc1a323f71726b6d"><td class="memItemLeft" align="right" valign="top"><a id="ad64423c55a30920abc1a323f71726b6d"></a> +QPID_MESSAGING_EXTERN </td><td class="memItemRight" valign="bottom"><b>Sender</b> (const <a class="el" href="classqpid_1_1messaging_1_1Sender.html">Sender</a> &)</td></tr> +<tr class="separator:ad64423c55a30920abc1a323f71726b6d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acf80f34af897d7459ddd717d334682a6"><td class="memItemLeft" align="right" valign="top"><a id="acf80f34af897d7459ddd717d334682a6"></a> +QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Sender.html">Sender</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classqpid_1_1messaging_1_1Sender.html">Sender</a> &)</td></tr> +<tr class="separator:acf80f34af897d7459ddd717d334682a6"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adedcff9ec995b301479d395f995736a9"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#adedcff9ec995b301479d395f995736a9">send</a> (const <a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> &message, bool sync=false)</td></tr> +<tr class="separator:adedcff9ec995b301479d395f995736a9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a54762fe305422a3e51b4d0a8152e030b"><td class="memItemLeft" align="right" valign="top"><a id="a54762fe305422a3e51b4d0a8152e030b"></a> +QPID_MESSAGING_EXTERN void </td><td class="memItemRight" valign="bottom"><b>close</b> ()</td></tr> +<tr class="separator:a54762fe305422a3e51b4d0a8152e030b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a93ade0badc46bb1a9f5662579145e4ce"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#a93ade0badc46bb1a9f5662579145e4ce">setCapacity</a> (uint32_t)</td></tr> +<tr class="separator:a93ade0badc46bb1a9f5662579145e4ce"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae23edfc07ba612172c314b044f1e7dcc"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#ae23edfc07ba612172c314b044f1e7dcc">getCapacity</a> ()</td></tr> +<tr class="separator:ae23edfc07ba612172c314b044f1e7dcc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1dd1f41ed7b5fcb2c8049692e865f049"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#a1dd1f41ed7b5fcb2c8049692e865f049">getUnsettled</a> ()</td></tr> +<tr class="separator:a1dd1f41ed7b5fcb2c8049692e865f049"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2aaec7fcb5362df5f5c3c63acaf61c21"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#a2aaec7fcb5362df5f5c3c63acaf61c21">getAvailable</a> ()</td></tr> +<tr class="separator:a2aaec7fcb5362df5f5c3c63acaf61c21"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aefd663292892953f615dca87b10a4be1"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#aefd663292892953f615dca87b10a4be1">getName</a> () const</td></tr> +<tr class="separator:aefd663292892953f615dca87b10a4be1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af7b50f2dbbd0887da8059416bbe4e823"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Session.html">Session</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#af7b50f2dbbd0887da8059416bbe4e823">getSession</a> () const</td></tr> +<tr class="separator:af7b50f2dbbd0887da8059416bbe4e823"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a53e25e4f4275ac9e3ca23d5ba442e6e8"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Address.html">Address</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Sender.html#a53e25e4f4275ac9e3ca23d5ba442e6e8">getAddress</a> () const</td></tr> +<tr class="separator:a53e25e4f4275ac9e3ca23d5ba442e6e8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_methods_classqpid_1_1messaging_1_1Handle"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classqpid_1_1messaging_1_1Handle')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td></tr> +<tr class="memitem:abdfd2c1acc987f8028a671066a8d6a47 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_INLINE_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#abdfd2c1acc987f8028a671066a8d6a47">isValid</a> () const</td></tr> +<tr class="separator:abdfd2c1acc987f8028a671066a8d6a47 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a484818fd643933443d8a2fda3ad1f9b3 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_INLINE_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#a484818fd643933443d8a2fda3ad1f9b3">isNull</a> () const</td></tr> +<tr class="separator:a484818fd643933443d8a2fda3ad1f9b3 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab7b5bd2c70cfdeeaa7a87d6713f26dfd inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_INLINE_EXTERN </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#ab7b5bd2c70cfdeeaa7a87d6713f26dfd">operator bool</a> () const</td></tr> +<tr class="separator:ab7b5bd2c70cfdeeaa7a87d6713f26dfd inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5ebf515ed24d99a08e368e1c3c61b042 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top">QPID_MESSAGING_INLINE_EXTERN bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classqpid_1_1messaging_1_1Handle.html#a5ebf515ed24d99a08e368e1c3c61b042">operator!</a> () const</td></tr> +<tr class="separator:a5ebf515ed24d99a08e368e1c3c61b042 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a65237851b8de03d0a366f5e02c3ca5c4 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a65237851b8de03d0a366f5e02c3ca5c4"></a> +void </td><td class="memItemRight" valign="bottom"><b>swap</b> (<a class="el" href="classqpid_1_1messaging_1_1Handle.html">Handle</a>< SenderImpl > &h)</td></tr> +<tr class="separator:a65237851b8de03d0a366f5e02c3ca5c4 inherit pub_methods_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> +Friends</h2></td></tr> +<tr class="memitem:a4c9fb62a74944f8a3b29193eacd4ecb1"><td class="memItemLeft" align="right" valign="top"><a id="a4c9fb62a74944f8a3b29193eacd4ecb1"></a> +class </td><td class="memItemRight" valign="bottom"><b>qpid::messaging::PrivateImplRef< Sender ></b></td></tr> +<tr class="separator:a4c9fb62a74944f8a3b29193eacd4ecb1"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pro_types_classqpid_1_1messaging_1_1Handle"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classqpid_1_1messaging_1_1Handle')"><img src="closed.png" alt="-"/> Protected Types inherited from <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td></tr> +<tr class="memitem:aae44d218cffcb40859af8702e4635d3f inherit pro_types_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="aae44d218cffcb40859af8702e4635d3f"></a> +typedef SenderImpl </td><td class="memItemRight" valign="bottom"><b>Impl</b></td></tr> +<tr class="separator:aae44d218cffcb40859af8702e4635d3f inherit pro_types_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pro_attribs_classqpid_1_1messaging_1_1Handle"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classqpid_1_1messaging_1_1Handle')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classqpid_1_1messaging_1_1Handle.html">qpid::messaging::Handle< SenderImpl ></a></td></tr> +<tr class="memitem:a56e6095295d9b798d9df9f4c53e80e32 inherit pro_attribs_classqpid_1_1messaging_1_1Handle"><td class="memItemLeft" align="right" valign="top"><a id="a56e6095295d9b798d9df9f4c53e80e32"></a> +Impl * </td><td class="memItemRight" valign="bottom"><b>impl</b></td></tr> +<tr class="separator:a56e6095295d9b798d9df9f4c53e80e32 inherit pro_attribs_classqpid_1_1messaging_1_1Handle"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Interface through which messages are sent. </p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a53e25e4f4275ac9e3ca23d5ba442e6e8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a53e25e4f4275ac9e3ca23d5ba442e6e8">◆ </a></span>getAddress()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Address.html">Address</a> qpid::messaging::Sender::getAddress </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns an address for this sender. </p> + +</div> +</div> +<a id="a2aaec7fcb5362df5f5c3c63acaf61c21"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2aaec7fcb5362df5f5c3c63acaf61c21">◆ </a></span>getAvailable()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN uint32_t qpid::messaging::Sender::getAvailable </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns the number of messages for which there is available capacity. </p> + +</div> +</div> +<a id="ae23edfc07ba612172c314b044f1e7dcc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae23edfc07ba612172c314b044f1e7dcc">◆ </a></span>getCapacity()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN uint32_t qpid::messaging::Sender::getCapacity </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns the capacity of the sender. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classqpid_1_1messaging_1_1Sender.html#a93ade0badc46bb1a9f5662579145e4ce">setCapacity</a> </dd></dl> + +</div> +</div> +<a id="aefd663292892953f615dca87b10a4be1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aefd663292892953f615dca87b10a4be1">◆ </a></span>getName()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN const std::string& qpid::messaging::Sender::getName </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns the name of this sender. </p> + +</div> +</div> +<a id="af7b50f2dbbd0887da8059416bbe4e823"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af7b50f2dbbd0887da8059416bbe4e823">◆ </a></span>getSession()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN <a class="el" href="classqpid_1_1messaging_1_1Session.html">Session</a> qpid::messaging::Sender::getSession </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns a handle to the session associated with this sender. </p> + +</div> +</div> +<a id="a1dd1f41ed7b5fcb2c8049692e865f049"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1dd1f41ed7b5fcb2c8049692e865f049">◆ </a></span>getUnsettled()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN uint32_t qpid::messaging::Sender::getUnsettled </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns the number of sent messages pending confirmation of receipt by the broker. (These are the 'in-doubt' messages). </p> + +</div> +</div> +<a id="adedcff9ec995b301479d395f995736a9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adedcff9ec995b301479d395f995736a9">◆ </a></span>send()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN void qpid::messaging::Sender::send </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classqpid_1_1messaging_1_1Message.html">Message</a> & </td> + <td class="paramname"><em>message</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"><em>sync</em> = <code>false</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Sends a message</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">message</td><td>the message to send </td></tr> + <tr><td class="paramname">sync</td><td>if true the call will block until the server confirms receipt of the messages; if false will only block for available capacity (i.e. pending == capacity) </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a93ade0badc46bb1a9f5662579145e4ce"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a93ade0badc46bb1a9f5662579145e4ce">◆ </a></span>setCapacity()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QPID_MESSAGING_EXTERN void qpid::messaging::Sender::setCapacity </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Sets the capacity for the sender. The capacity determines how many outgoing messages can be held pending confirmation of receipt by the broker. </p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>qpid/messaging/<a class="el" href="Sender_8h_source.html">Sender.h</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"><b>qpid</b></li><li class="navelem"><b>messaging</b></li><li class="navelem"><a class="el" href="classqpid_1_1messaging_1_1Sender.html">Sender</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.13 </li> + </ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/qpid-site/blob/c3ab60f6/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.js b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.js new file mode 100755 index 0000000..20e77a3 --- /dev/null +++ b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.js @@ -0,0 +1,17 @@ +var classqpid_1_1messaging_1_1Sender = +[ + [ "Sender", "classqpid_1_1messaging_1_1Sender.html#a89456a418e984a42c7efb656478ff3ca", null ], + [ "Sender", "classqpid_1_1messaging_1_1Sender.html#ad64423c55a30920abc1a323f71726b6d", null ], + [ "~Sender", "classqpid_1_1messaging_1_1Sender.html#ae9d3cc1b2049bc9c70662c91075ebcbf", null ], + [ "close", "classqpid_1_1messaging_1_1Sender.html#a54762fe305422a3e51b4d0a8152e030b", null ], + [ "getAddress", "classqpid_1_1messaging_1_1Sender.html#a53e25e4f4275ac9e3ca23d5ba442e6e8", null ], + [ "getAvailable", "classqpid_1_1messaging_1_1Sender.html#a2aaec7fcb5362df5f5c3c63acaf61c21", null ], + [ "getCapacity", "classqpid_1_1messaging_1_1Sender.html#ae23edfc07ba612172c314b044f1e7dcc", null ], + [ "getName", "classqpid_1_1messaging_1_1Sender.html#aefd663292892953f615dca87b10a4be1", null ], + [ "getSession", "classqpid_1_1messaging_1_1Sender.html#af7b50f2dbbd0887da8059416bbe4e823", null ], + [ "getUnsettled", "classqpid_1_1messaging_1_1Sender.html#a1dd1f41ed7b5fcb2c8049692e865f049", null ], + [ "operator=", "classqpid_1_1messaging_1_1Sender.html#acf80f34af897d7459ddd717d334682a6", null ], + [ "send", "classqpid_1_1messaging_1_1Sender.html#adedcff9ec995b301479d395f995736a9", null ], + [ "setCapacity", "classqpid_1_1messaging_1_1Sender.html#a93ade0badc46bb1a9f5662579145e4ce", null ], + [ "qpid::messaging::PrivateImplRef< Sender >", "classqpid_1_1messaging_1_1Sender.html#a4c9fb62a74944f8a3b29193eacd4ecb1", null ] +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/c3ab60f6/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.png ---------------------------------------------------------------------- diff --git a/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.png b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.png new file mode 100755 index 0000000..da4bf71 Binary files /dev/null and b/content/releases/qpid-cpp-1.39.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Sender.png differ --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org