| <!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: Messenger</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function() { init_search(); }); |
| /* @license-end */ |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Qpid Proton C API |
|  <span id="projectnumber">0.32.0</span> |
| </div> |
| </td> |
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.svg" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a> |
| </span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.20 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| </div><!-- top --> |
| <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| <div id="nav-tree"> |
| <div id="nav-tree-contents"> |
| <div id="nav-sync" class="sync"></div> |
| </div> |
| </div> |
| <div id="splitbar" style="-moz-user-select:none;" |
| class="ui-resizable-handle"> |
| </div> |
| </div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('group__messenger.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="#define-members">Macros</a> | |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Messenger</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><b>Deprecated</b> - Use the <a class="el" href="group__proactor.html">Proactor</a> API or Qpid Proton C++. |
| <a href="#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:ga6c2e8d006ec05b913fa1e6dc510d23b9"><td class="memItemLeft" align="right" valign="top"><a id="ga6c2e8d006ec05b913fa1e6dc510d23b9"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga6c2e8d006ec05b913fa1e6dc510d23b9">PN_CUMULATIVE</a></td></tr> |
| <tr class="memdesc:ga6c2e8d006ec05b913fa1e6dc510d23b9"><td class="mdescLeft"> </td><td class="mdescRight">Indicates that an accept or reject should operate cumulatively. <br /></td></tr> |
| <tr class="separator:ga6c2e8d006ec05b913fa1e6dc510d23b9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad5ad0b67fef0e761dc0138b9621ffa14"><td class="memItemLeft" align="right" valign="top"><a id="gad5ad0b67fef0e761dc0138b9621ffa14"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gad5ad0b67fef0e761dc0138b9621ffa14">PN_FLAGS_CHECK_ROUTES</a></td></tr> |
| <tr class="memdesc:gad5ad0b67fef0e761dc0138b9621ffa14"><td class="mdescLeft"> </td><td class="mdescRight">Messenger flag to indicate that a call \ to pn_messenger_start should check that \ any defined routes are valid. <br /></td></tr> |
| <tr class="separator:gad5ad0b67fef0e761dc0138b9621ffa14"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga118fb0c2384257dff5d72eea787e4a0c"><td class="memItemLeft" align="right" valign="top"><a id="ga118fb0c2384257dff5d72eea787e4a0c"></a> |
| #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga118fb0c2384257dff5d72eea787e4a0c">PN_FLAGS_ALLOW_INSECURE_MECHS</a></td></tr> |
| <tr class="memdesc:ga118fb0c2384257dff5d72eea787e4a0c"><td class="mdescLeft"> </td><td class="mdescRight">Messenger flag to indicate that the PLAIN \ mechanism is allowed on an unencrypted \ connection. <br /></td></tr> |
| <tr class="separator:ga118fb0c2384257dff5d72eea787e4a0c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:ga0d342bb795d48591ad6b3f867766b8b1"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a></td></tr> |
| <tr class="memdesc:ga0d342bb795d48591ad6b3f867766b8b1"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1" title="A pn_messenger_t provides a high level interface for sending and receiving messages (See pn_message_t...">pn_messenger_t</a> provides a high level interface for sending and receiving messages (See <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2" title="An AMQP Message object.">pn_message_t</a>). <a href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">More...</a><br /></td></tr> |
| <tr class="separator:ga0d342bb795d48591ad6b3f867766b8b1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gabd73703511b9dae193765e9e57864291"><td class="memItemLeft" align="right" valign="top"><a id="gabd73703511b9dae193765e9e57864291"></a> |
| typedef struct <a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a></td></tr> |
| <tr class="memdesc:gabd73703511b9dae193765e9e57864291"><td class="mdescLeft"> </td><td class="mdescRight">A subscription is a request for incoming messages. <br /></td></tr> |
| <tr class="separator:gabd73703511b9dae193765e9e57864291"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gab1173cfe4bcaa0a530c8035dc75f42c7"><td class="memItemLeft" align="right" valign="top"><a id="gab1173cfe4bcaa0a530c8035dc75f42c7"></a> |
| typedef int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a></td></tr> |
| <tr class="memdesc:gab1173cfe4bcaa0a530c8035dc75f42c7"><td class="mdescLeft"> </td><td class="mdescRight">Trackers provide a lightweight handle used to track the status of incoming and outgoing deliveries. <br /></td></tr> |
| <tr class="separator:gab1173cfe4bcaa0a530c8035dc75f42c7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:ga242e4ee54b9c0a416443c7da5f6e045b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga242e4ee54b9c0a416443c7da5f6e045b">pn_status_t</a> { <br /> |
|   <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba0b46b1041679460baaba2ddcdb2173f2">PN_STATUS_UNKNOWN</a>, |
| <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba4b0354a77173cd75c69159e15c23f611">PN_STATUS_PENDING</a>, |
| <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba693fd9044a50a4f02e842d04a4bf1467">PN_STATUS_ACCEPTED</a>, |
| <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045baf109df703952744009b3547f3b8f32bf">PN_STATUS_REJECTED</a>, |
| <br /> |
|   <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba67079750477effb7935df83381c47852">PN_STATUS_RELEASED</a>, |
| <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba77d94a6b6b745eef9307f144b57e81e8">PN_STATUS_MODIFIED</a>, |
| <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba1239e8ada7eabe2aeab98f2c881cd2ee">PN_STATUS_ABORTED</a>, |
| <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba1181bc7f51502ae11ed240866cd64583">PN_STATUS_SETTLED</a> |
| <br /> |
| }</td></tr> |
| <tr class="memdesc:ga242e4ee54b9c0a416443c7da5f6e045b"><td class="mdescLeft"> </td><td class="mdescRight">Describes all the possible states for a message associated with a given tracker. <a href="group__messenger.html#ga242e4ee54b9c0a416443c7da5f6e045b">More...</a><br /></td></tr> |
| <tr class="separator:ga242e4ee54b9c0a416443c7da5f6e045b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:gabe045d16ca8eb1e3cc87387e2ae82433"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gabe045d16ca8eb1e3cc87387e2ae82433">pn_messenger</a> (const char *name)</td></tr> |
| <tr class="memdesc:gabe045d16ca8eb1e3cc87387e2ae82433"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1" title="A pn_messenger_t provides a high level interface for sending and receiving messages (See pn_message_t...">pn_messenger_t</a> with the given name. <a href="group__messenger.html#gabe045d16ca8eb1e3cc87387e2ae82433">More...</a><br /></td></tr> |
| <tr class="separator:gabe045d16ca8eb1e3cc87387e2ae82433"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga71197163a69770575df74e3cee617429"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga71197163a69770575df74e3cee617429">pn_messenger_name</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga71197163a69770575df74e3cee617429"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of a messenger. <a href="group__messenger.html#ga71197163a69770575df74e3cee617429">More...</a><br /></td></tr> |
| <tr class="separator:ga71197163a69770575df74e3cee617429"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad61fff52c28501171ecbb0b21bbde954"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gad61fff52c28501171ecbb0b21bbde954">pn_messenger_set_certificate</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *certificate)</td></tr> |
| <tr class="memdesc:gad61fff52c28501171ecbb0b21bbde954"><td class="mdescLeft"> </td><td class="mdescRight">Sets the path that will be used to get the certificate that will be used to identify this messenger to its peers. <a href="group__messenger.html#gad61fff52c28501171ecbb0b21bbde954">More...</a><br /></td></tr> |
| <tr class="separator:gad61fff52c28501171ecbb0b21bbde954"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga1d0c003a1fb5e20b894e2deb8b43118b"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga1d0c003a1fb5e20b894e2deb8b43118b">pn_messenger_get_certificate</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga1d0c003a1fb5e20b894e2deb8b43118b"><td class="mdescLeft"> </td><td class="mdescRight">Get the certificate path. <a href="group__messenger.html#ga1d0c003a1fb5e20b894e2deb8b43118b">More...</a><br /></td></tr> |
| <tr class="separator:ga1d0c003a1fb5e20b894e2deb8b43118b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga05f059a2fe93e0acbcf76e494e6bf958"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga05f059a2fe93e0acbcf76e494e6bf958">pn_messenger_set_private_key</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *private_key)</td></tr> |
| <tr class="memdesc:ga05f059a2fe93e0acbcf76e494e6bf958"><td class="mdescLeft"> </td><td class="mdescRight">Set path to the private key that was used to sign the certificate. <a href="group__messenger.html#ga05f059a2fe93e0acbcf76e494e6bf958">More...</a><br /></td></tr> |
| <tr class="separator:ga05f059a2fe93e0acbcf76e494e6bf958"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gab692f989aed2aa83bd71b7fa7196aeb1"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gab692f989aed2aa83bd71b7fa7196aeb1">pn_messenger_get_private_key</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:gab692f989aed2aa83bd71b7fa7196aeb1"><td class="mdescLeft"> </td><td class="mdescRight">Gets the private key file for a messenger. <a href="group__messenger.html#gab692f989aed2aa83bd71b7fa7196aeb1">More...</a><br /></td></tr> |
| <tr class="separator:gab692f989aed2aa83bd71b7fa7196aeb1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga6b04f7dea2ed8752b8672b4cfe0330f2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga6b04f7dea2ed8752b8672b4cfe0330f2">pn_messenger_set_password</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *password)</td></tr> |
| <tr class="memdesc:ga6b04f7dea2ed8752b8672b4cfe0330f2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the private key password for a messenger. <a href="group__messenger.html#ga6b04f7dea2ed8752b8672b4cfe0330f2">More...</a><br /></td></tr> |
| <tr class="separator:ga6b04f7dea2ed8752b8672b4cfe0330f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3f02ad7340a59c5982e6223aaeea803a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga3f02ad7340a59c5982e6223aaeea803a">pn_messenger_get_password</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga3f02ad7340a59c5982e6223aaeea803a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the private key file password for a messenger. <a href="group__messenger.html#ga3f02ad7340a59c5982e6223aaeea803a">More...</a><br /></td></tr> |
| <tr class="separator:ga3f02ad7340a59c5982e6223aaeea803a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad901e92e2bee6d5371dcd3b1c8fe2c3b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gad901e92e2bee6d5371dcd3b1c8fe2c3b">pn_messenger_set_trusted_certificates</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *cert_db)</td></tr> |
| <tr class="memdesc:gad901e92e2bee6d5371dcd3b1c8fe2c3b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the trusted certificates database for a messenger. <a href="group__messenger.html#gad901e92e2bee6d5371dcd3b1c8fe2c3b">More...</a><br /></td></tr> |
| <tr class="separator:gad901e92e2bee6d5371dcd3b1c8fe2c3b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga955b218a8f58560e9e228ca14fba21f2"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga955b218a8f58560e9e228ca14fba21f2">pn_messenger_get_trusted_certificates</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga955b218a8f58560e9e228ca14fba21f2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the trusted certificates database for a messenger. <a href="group__messenger.html#ga955b218a8f58560e9e228ca14fba21f2">More...</a><br /></td></tr> |
| <tr class="separator:ga955b218a8f58560e9e228ca14fba21f2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga04119bb2b16bb0f657f1dbcf73827d74"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga04119bb2b16bb0f657f1dbcf73827d74">pn_messenger_set_timeout</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, int timeout)</td></tr> |
| <tr class="memdesc:ga04119bb2b16bb0f657f1dbcf73827d74"><td class="mdescLeft"> </td><td class="mdescRight">Set the default timeout for a messenger. <a href="group__messenger.html#ga04119bb2b16bb0f657f1dbcf73827d74">More...</a><br /></td></tr> |
| <tr class="separator:ga04119bb2b16bb0f657f1dbcf73827d74"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga083ba6296a1ae1dfe45c0fb82da823eb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga083ba6296a1ae1dfe45c0fb82da823eb">pn_messenger_get_timeout</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga083ba6296a1ae1dfe45c0fb82da823eb"><td class="mdescLeft"> </td><td class="mdescRight">Gets the timeout for a messenger object. <a href="group__messenger.html#ga083ba6296a1ae1dfe45c0fb82da823eb">More...</a><br /></td></tr> |
| <tr class="separator:ga083ba6296a1ae1dfe45c0fb82da823eb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaf572cbf224105d08898d2906336712f7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gaf572cbf224105d08898d2906336712f7">pn_messenger_is_blocking</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:gaf572cbf224105d08898d2906336712f7"><td class="mdescLeft"> </td><td class="mdescRight">Check if a messenger is in blocking mode. <a href="group__messenger.html#gaf572cbf224105d08898d2906336712f7">More...</a><br /></td></tr> |
| <tr class="separator:gaf572cbf224105d08898d2906336712f7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae9d7f1aec6e2cf3ef1ee326a4ae15981"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gae9d7f1aec6e2cf3ef1ee326a4ae15981">pn_messenger_set_blocking</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, bool blocking)</td></tr> |
| <tr class="memdesc:gae9d7f1aec6e2cf3ef1ee326a4ae15981"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable blocking behavior for a messenger during calls to <a class="el" href="group__messenger.html#gae31f9a99dcbedffe83588cf25b805325" title="Send messages from a messenger's outgoing queue.">pn_messenger_send</a> and <a class="el" href="group__messenger.html#ga16c945185e4eb5dcb9aac2be2fcab0d6" title="Retrieve messages into a messenger's incoming queue.">pn_messenger_recv</a>. <a href="group__messenger.html#gae9d7f1aec6e2cf3ef1ee326a4ae15981">More...</a><br /></td></tr> |
| <tr class="separator:gae9d7f1aec6e2cf3ef1ee326a4ae15981"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga63805c35f18ef041c69a14564dc1bce4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga63805c35f18ef041c69a14564dc1bce4">pn_messenger_is_passive</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga63805c35f18ef041c69a14564dc1bce4"><td class="mdescLeft"> </td><td class="mdescRight">Check if a messenger is in passive mode. <a href="group__messenger.html#ga63805c35f18ef041c69a14564dc1bce4">More...</a><br /></td></tr> |
| <tr class="separator:ga63805c35f18ef041c69a14564dc1bce4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac7df7c92396f10f105ec74d35310a7c0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gac7df7c92396f10f105ec74d35310a7c0">pn_messenger_set_passive</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, bool passive)</td></tr> |
| <tr class="memdesc:gac7df7c92396f10f105ec74d35310a7c0"><td class="mdescLeft"> </td><td class="mdescRight">Set the passive mode for a messenger. <a href="group__messenger.html#gac7df7c92396f10f105ec74d35310a7c0">More...</a><br /></td></tr> |
| <tr class="separator:gac7df7c92396f10f105ec74d35310a7c0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga530295575eda95e3c19316d41bd1baa7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga530295575eda95e3c19316d41bd1baa7">pn_messenger_free</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga530295575eda95e3c19316d41bd1baa7"><td class="mdescLeft"> </td><td class="mdescRight">Frees a Messenger. <a href="group__messenger.html#ga530295575eda95e3c19316d41bd1baa7">More...</a><br /></td></tr> |
| <tr class="separator:ga530295575eda95e3c19316d41bd1baa7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gacfd10311abca28521fe7aa9cabfff61c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gacfd10311abca28521fe7aa9cabfff61c">pn_messenger_errno</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:gacfd10311abca28521fe7aa9cabfff61c"><td class="mdescLeft"> </td><td class="mdescRight">Get the code for a messenger's most recent error. <a href="group__messenger.html#gacfd10311abca28521fe7aa9cabfff61c">More...</a><br /></td></tr> |
| <tr class="separator:gacfd10311abca28521fe7aa9cabfff61c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga0301664be9c54b3a573578776ad2a5d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga0301664be9c54b3a573578776ad2a5d2">pn_messenger_error</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga0301664be9c54b3a573578776ad2a5d2"><td class="mdescLeft"> </td><td class="mdescRight">Get a messenger's error object. <a href="group__messenger.html#ga0301664be9c54b3a573578776ad2a5d2">More...</a><br /></td></tr> |
| <tr class="separator:ga0301664be9c54b3a573578776ad2a5d2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac191bdb410b7839d6306a0d8e5ac19e1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gac191bdb410b7839d6306a0d8e5ac19e1">pn_messenger_get_outgoing_window</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:gac191bdb410b7839d6306a0d8e5ac19e1"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of a messenger's outgoing window. <a href="group__messenger.html#gac191bdb410b7839d6306a0d8e5ac19e1">More...</a><br /></td></tr> |
| <tr class="separator:gac191bdb410b7839d6306a0d8e5ac19e1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga96487581bd8348f8bc9bacef25042cfc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga96487581bd8348f8bc9bacef25042cfc">pn_messenger_set_outgoing_window</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, int window)</td></tr> |
| <tr class="memdesc:ga96487581bd8348f8bc9bacef25042cfc"><td class="mdescLeft"> </td><td class="mdescRight">Set the size of a messenger's outgoing window. <a href="group__messenger.html#ga96487581bd8348f8bc9bacef25042cfc">More...</a><br /></td></tr> |
| <tr class="separator:ga96487581bd8348f8bc9bacef25042cfc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga45d578f39673ad59ca65d2042054abee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga45d578f39673ad59ca65d2042054abee">pn_messenger_get_incoming_window</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga45d578f39673ad59ca65d2042054abee"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of a messenger's incoming window. <a href="group__messenger.html#ga45d578f39673ad59ca65d2042054abee">More...</a><br /></td></tr> |
| <tr class="separator:ga45d578f39673ad59ca65d2042054abee"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gadf8a9cf14bf8d519026ea8c4eeb275c3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gadf8a9cf14bf8d519026ea8c4eeb275c3">pn_messenger_set_incoming_window</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, int window)</td></tr> |
| <tr class="memdesc:gadf8a9cf14bf8d519026ea8c4eeb275c3"><td class="mdescLeft"> </td><td class="mdescRight">Set the size of a messenger's incoming window. <a href="group__messenger.html#gadf8a9cf14bf8d519026ea8c4eeb275c3">More...</a><br /></td></tr> |
| <tr class="separator:gadf8a9cf14bf8d519026ea8c4eeb275c3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga6fa594235e316cd2a04b44b283194a43"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga6fa594235e316cd2a04b44b283194a43">pn_messenger_start</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga6fa594235e316cd2a04b44b283194a43"><td class="mdescLeft"> </td><td class="mdescRight">Currently a no-op placeholder. <a href="group__messenger.html#ga6fa594235e316cd2a04b44b283194a43">More...</a><br /></td></tr> |
| <tr class="separator:ga6fa594235e316cd2a04b44b283194a43"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad95ab6daf6b2a61b79d5128a7d1d9f5c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gad95ab6daf6b2a61b79d5128a7d1d9f5c">pn_messenger_stop</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:gad95ab6daf6b2a61b79d5128a7d1d9f5c"><td class="mdescLeft"> </td><td class="mdescRight">Stops a messenger. <a href="group__messenger.html#gad95ab6daf6b2a61b79d5128a7d1d9f5c">More...</a><br /></td></tr> |
| <tr class="separator:gad95ab6daf6b2a61b79d5128a7d1d9f5c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae2c4765839c8fd09c0e01d05a118b6d4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gae2c4765839c8fd09c0e01d05a118b6d4">pn_messenger_stopped</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:gae2c4765839c8fd09c0e01d05a118b6d4"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a messenger is in the stopped state. <a href="group__messenger.html#gae2c4765839c8fd09c0e01d05a118b6d4">More...</a><br /></td></tr> |
| <tr class="separator:gae2c4765839c8fd09c0e01d05a118b6d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac36589fe5dc0378cf62558e40060a26f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gac36589fe5dc0378cf62558e40060a26f">pn_messenger_subscribe</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *source)</td></tr> |
| <tr class="memdesc:gac36589fe5dc0378cf62558e40060a26f"><td class="mdescLeft"> </td><td class="mdescRight">Subscribes a messenger to messages from the specified source. <a href="group__messenger.html#gac36589fe5dc0378cf62558e40060a26f">More...</a><br /></td></tr> |
| <tr class="separator:gac36589fe5dc0378cf62558e40060a26f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga480a8623fab904690218c0c67493232f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga480a8623fab904690218c0c67493232f">pn_messenger_subscribe_ttl</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *source, <a class="el" href="group__api__types.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> timeout)</td></tr> |
| <tr class="memdesc:ga480a8623fab904690218c0c67493232f"><td class="mdescLeft"> </td><td class="mdescRight">Subscribes a messenger to messages from the specified source with the given timeout for the subscription's lifetime. <a href="group__messenger.html#ga480a8623fab904690218c0c67493232f">More...</a><br /></td></tr> |
| <tr class="separator:ga480a8623fab904690218c0c67493232f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga757aeef23d47ecc2a9a461b882686417"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga757aeef23d47ecc2a9a461b882686417">pn_messenger_get_link</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *address, bool sender)</td></tr> |
| <tr class="memdesc:ga757aeef23d47ecc2a9a461b882686417"><td class="mdescLeft"> </td><td class="mdescRight">Get a link based on link name and whether the link is a sender or receiver. <a href="group__messenger.html#ga757aeef23d47ecc2a9a461b882686417">More...</a><br /></td></tr> |
| <tr class="separator:ga757aeef23d47ecc2a9a461b882686417"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga8ad0f0db6d7cfe0e95d44d433843d787"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga8ad0f0db6d7cfe0e95d44d433843d787">pn_subscription_get_context</a> (<a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> *sub)</td></tr> |
| <tr class="memdesc:ga8ad0f0db6d7cfe0e95d44d433843d787"><td class="mdescLeft"> </td><td class="mdescRight">Get a subscription's application context. <a href="group__messenger.html#ga8ad0f0db6d7cfe0e95d44d433843d787">More...</a><br /></td></tr> |
| <tr class="separator:ga8ad0f0db6d7cfe0e95d44d433843d787"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3a7f95a2a86f64babe692d21ffe9cd10"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga3a7f95a2a86f64babe692d21ffe9cd10">pn_subscription_set_context</a> (<a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> *sub, void *context)</td></tr> |
| <tr class="memdesc:ga3a7f95a2a86f64babe692d21ffe9cd10"><td class="mdescLeft"> </td><td class="mdescRight">Set an application context for a subscription. <a href="group__messenger.html#ga3a7f95a2a86f64babe692d21ffe9cd10">More...</a><br /></td></tr> |
| <tr class="separator:ga3a7f95a2a86f64babe692d21ffe9cd10"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga8e87c040776f1941f21d2c15f24b835e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga8e87c040776f1941f21d2c15f24b835e">pn_subscription_address</a> (<a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> *sub)</td></tr> |
| <tr class="memdesc:ga8e87c040776f1941f21d2c15f24b835e"><td class="mdescLeft"> </td><td class="mdescRight">Get the source address of a subscription. <a href="group__messenger.html#ga8e87c040776f1941f21d2c15f24b835e">More...</a><br /></td></tr> |
| <tr class="separator:ga8e87c040776f1941f21d2c15f24b835e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gafede68af29484d50d531cc48ab0d3d4a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gafede68af29484d50d531cc48ab0d3d4a">pn_messenger_put</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> *msg)</td></tr> |
| <tr class="memdesc:gafede68af29484d50d531cc48ab0d3d4a"><td class="mdescLeft"> </td><td class="mdescRight">Puts a message onto the messenger's outgoing queue. <a href="group__messenger.html#gafede68af29484d50d531cc48ab0d3d4a">More...</a><br /></td></tr> |
| <tr class="separator:gafede68af29484d50d531cc48ab0d3d4a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad398544ad1374f67c922115ae1cceacc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__messenger.html#ga242e4ee54b9c0a416443c7da5f6e045b">pn_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gad398544ad1374f67c922115ae1cceacc">pn_messenger_status</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> tracker)</td></tr> |
| <tr class="memdesc:gad398544ad1374f67c922115ae1cceacc"><td class="mdescLeft"> </td><td class="mdescRight">Track the status of a delivery. <a href="group__messenger.html#gad398544ad1374f67c922115ae1cceacc">More...</a><br /></td></tr> |
| <tr class="separator:gad398544ad1374f67c922115ae1cceacc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga65f22122f08bc93de2bfe155aa12d0b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga65f22122f08bc93de2bfe155aa12d0b0">pn_messenger_delivery</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> tracker)</td></tr> |
| <tr class="memdesc:ga65f22122f08bc93de2bfe155aa12d0b0"><td class="mdescLeft"> </td><td class="mdescRight">Get delivery information about a delivery. <a href="group__messenger.html#ga65f22122f08bc93de2bfe155aa12d0b0">More...</a><br /></td></tr> |
| <tr class="separator:ga65f22122f08bc93de2bfe155aa12d0b0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga15adeb707f15b86df1e5486c34a060e6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga15adeb707f15b86df1e5486c34a060e6">pn_messenger_buffered</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> tracker)</td></tr> |
| <tr class="memdesc:ga15adeb707f15b86df1e5486c34a060e6"><td class="mdescLeft"> </td><td class="mdescRight">Check if the delivery associated with a given tracker is still waiting to be sent. <a href="group__messenger.html#ga15adeb707f15b86df1e5486c34a060e6">More...</a><br /></td></tr> |
| <tr class="separator:ga15adeb707f15b86df1e5486c34a060e6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga475ce593f6b0c6025516ae48360dee4d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga475ce593f6b0c6025516ae48360dee4d">pn_messenger_settle</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> tracker, int flags)</td></tr> |
| <tr class="memdesc:ga475ce593f6b0c6025516ae48360dee4d"><td class="mdescLeft"> </td><td class="mdescRight">Frees a Messenger from tracking the status associated with a given tracker. <a href="group__messenger.html#ga475ce593f6b0c6025516ae48360dee4d">More...</a><br /></td></tr> |
| <tr class="separator:ga475ce593f6b0c6025516ae48360dee4d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga0212b5cfe07a7f758ec472d67d0f56e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga0212b5cfe07a7f758ec472d67d0f56e1">pn_messenger_outgoing_tracker</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga0212b5cfe07a7f758ec472d67d0f56e1"><td class="mdescLeft"> </td><td class="mdescRight">Get a tracker for the outgoing message most recently given to pn_messenger_put. <a href="group__messenger.html#ga0212b5cfe07a7f758ec472d67d0f56e1">More...</a><br /></td></tr> |
| <tr class="separator:ga0212b5cfe07a7f758ec472d67d0f56e1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga47d60cec6a55e0675b8f073067eff9c4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga47d60cec6a55e0675b8f073067eff9c4">pn_messenger_work</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, int timeout)</td></tr> |
| <tr class="memdesc:ga47d60cec6a55e0675b8f073067eff9c4"><td class="mdescLeft"> </td><td class="mdescRight">Sends or receives any outstanding messages queued for a messenger. <a href="group__messenger.html#ga47d60cec6a55e0675b8f073067eff9c4">More...</a><br /></td></tr> |
| <tr class="separator:ga47d60cec6a55e0675b8f073067eff9c4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga9da14c67acc17bc5fec6f34e2749534f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga9da14c67acc17bc5fec6f34e2749534f">pn_messenger_interrupt</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga9da14c67acc17bc5fec6f34e2749534f"><td class="mdescLeft"> </td><td class="mdescRight">Interrupt a messenger object that may be blocking in another thread. <a href="group__messenger.html#ga9da14c67acc17bc5fec6f34e2749534f">More...</a><br /></td></tr> |
| <tr class="separator:ga9da14c67acc17bc5fec6f34e2749534f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae31f9a99dcbedffe83588cf25b805325"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gae31f9a99dcbedffe83588cf25b805325">pn_messenger_send</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, int n)</td></tr> |
| <tr class="memdesc:gae31f9a99dcbedffe83588cf25b805325"><td class="mdescLeft"> </td><td class="mdescRight">Send messages from a messenger's outgoing queue. <a href="group__messenger.html#gae31f9a99dcbedffe83588cf25b805325">More...</a><br /></td></tr> |
| <tr class="separator:gae31f9a99dcbedffe83588cf25b805325"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga16c945185e4eb5dcb9aac2be2fcab0d6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga16c945185e4eb5dcb9aac2be2fcab0d6">pn_messenger_recv</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, int limit)</td></tr> |
| <tr class="memdesc:ga16c945185e4eb5dcb9aac2be2fcab0d6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve messages into a messenger's incoming queue. <a href="group__messenger.html#ga16c945185e4eb5dcb9aac2be2fcab0d6">More...</a><br /></td></tr> |
| <tr class="separator:ga16c945185e4eb5dcb9aac2be2fcab0d6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaf4e22c8cb1436891d42ca0a658fca9c5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gaf4e22c8cb1436891d42ca0a658fca9c5">pn_messenger_receiving</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:gaf4e22c8cb1436891d42ca0a658fca9c5"><td class="mdescLeft"> </td><td class="mdescRight">Get the capacity of the incoming message queue of a messenger. <a href="group__messenger.html#gaf4e22c8cb1436891d42ca0a658fca9c5">More...</a><br /></td></tr> |
| <tr class="separator:gaf4e22c8cb1436891d42ca0a658fca9c5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaa6d85929e4b4b574690927ddde00c540"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gaa6d85929e4b4b574690927ddde00c540">pn_messenger_get</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> *message)</td></tr> |
| <tr class="memdesc:gaa6d85929e4b4b574690927ddde00c540"><td class="mdescLeft"> </td><td class="mdescRight">Get the next message from the head of a messenger's incoming queue. <a href="group__messenger.html#gaa6d85929e4b4b574690927ddde00c540">More...</a><br /></td></tr> |
| <tr class="separator:gaa6d85929e4b4b574690927ddde00c540"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gafe31e771826f8107d93fc276c9715aab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gafe31e771826f8107d93fc276c9715aab">pn_messenger_incoming_tracker</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:gafe31e771826f8107d93fc276c9715aab"><td class="mdescLeft"> </td><td class="mdescRight">Get a tracker for the message most recently retrieved by <a class="el" href="group__messenger.html#gaa6d85929e4b4b574690927ddde00c540" title="Get the next message from the head of a messenger's incoming queue.">pn_messenger_get()</a>. <a href="group__messenger.html#gafe31e771826f8107d93fc276c9715aab">More...</a><br /></td></tr> |
| <tr class="separator:gafe31e771826f8107d93fc276c9715aab"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae351d031d2ef29bdb137a59d461c4253"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gae351d031d2ef29bdb137a59d461c4253">pn_messenger_incoming_subscription</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:gae351d031d2ef29bdb137a59d461c4253"><td class="mdescLeft"> </td><td class="mdescRight">Get the subscription of the message most recently retrieved by <a class="el" href="group__messenger.html#gaa6d85929e4b4b574690927ddde00c540" title="Get the next message from the head of a messenger's incoming queue.">pn_messenger_get()</a>. <a href="group__messenger.html#gae351d031d2ef29bdb137a59d461c4253">More...</a><br /></td></tr> |
| <tr class="separator:gae351d031d2ef29bdb137a59d461c4253"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga11cd0d3423482e1ddda7a8b0cbb581c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga11cd0d3423482e1ddda7a8b0cbb581c7">pn_messenger_accept</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> tracker, int flags)</td></tr> |
| <tr class="memdesc:ga11cd0d3423482e1ddda7a8b0cbb581c7"><td class="mdescLeft"> </td><td class="mdescRight">Signal successful processing of message(s). <a href="group__messenger.html#ga11cd0d3423482e1ddda7a8b0cbb581c7">More...</a><br /></td></tr> |
| <tr class="separator:ga11cd0d3423482e1ddda7a8b0cbb581c7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga22d6de108fa967a43ab2473d6a915e9c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga22d6de108fa967a43ab2473d6a915e9c">pn_messenger_reject</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> tracker, int flags)</td></tr> |
| <tr class="memdesc:ga22d6de108fa967a43ab2473d6a915e9c"><td class="mdescLeft"> </td><td class="mdescRight">Signal unsuccessful processing of message(s). <a href="group__messenger.html#ga22d6de108fa967a43ab2473d6a915e9c">More...</a><br /></td></tr> |
| <tr class="separator:ga22d6de108fa967a43ab2473d6a915e9c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae4e5e89c6ea2a820a221af61cc741c7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gae4e5e89c6ea2a820a221af61cc741c7d">pn_messenger_tracker_link</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> tracker)</td></tr> |
| <tr class="memdesc:gae4e5e89c6ea2a820a221af61cc741c7d"><td class="mdescLeft"> </td><td class="mdescRight">Get link for the message referenced by the given tracker. <a href="group__messenger.html#gae4e5e89c6ea2a820a221af61cc741c7d">More...</a><br /></td></tr> |
| <tr class="separator:gae4e5e89c6ea2a820a221af61cc741c7d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga06c3a066422f8a966523b43a61f62eb9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga06c3a066422f8a966523b43a61f62eb9">pn_messenger_outgoing</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga06c3a066422f8a966523b43a61f62eb9"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of messages in the outgoing message queue of a messenger. <a href="group__messenger.html#ga06c3a066422f8a966523b43a61f62eb9">More...</a><br /></td></tr> |
| <tr class="separator:ga06c3a066422f8a966523b43a61f62eb9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga43cf91b5528c2729b3ff9ae1d2a7d257"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga43cf91b5528c2729b3ff9ae1d2a7d257">pn_messenger_incoming</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga43cf91b5528c2729b3ff9ae1d2a7d257"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of messages in the incoming message queue of a messenger. <a href="group__messenger.html#ga43cf91b5528c2729b3ff9ae1d2a7d257">More...</a><br /></td></tr> |
| <tr class="separator:ga43cf91b5528c2729b3ff9ae1d2a7d257"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga6c85a08d72ae73a18f9fb64ccf0c470e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga6c85a08d72ae73a18f9fb64ccf0c470e">pn_messenger_route</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *pattern, const char *address)</td></tr> |
| <tr class="memdesc:ga6c85a08d72ae73a18f9fb64ccf0c470e"><td class="mdescLeft"> </td><td class="mdescRight">Adds a routing rule to a Messenger's internal routing table. <a href="group__messenger.html#ga6c85a08d72ae73a18f9fb64ccf0c470e">More...</a><br /></td></tr> |
| <tr class="separator:ga6c85a08d72ae73a18f9fb64ccf0c470e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gac7dc5d9b82f9e015fd2c7d9743099eff"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gac7dc5d9b82f9e015fd2c7d9743099eff">pn_messenger_rewrite</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *pattern, const char *address)</td></tr> |
| <tr class="memdesc:gac7dc5d9b82f9e015fd2c7d9743099eff"><td class="mdescLeft"> </td><td class="mdescRight">Rewrite message addresses prior to transmission. <a href="group__messenger.html#gac7dc5d9b82f9e015fd2c7d9743099eff">More...</a><br /></td></tr> |
| <tr class="separator:gac7dc5d9b82f9e015fd2c7d9743099eff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga8521b0999200c076bf12568ac10fe925"><td class="memItemLeft" align="right" valign="top">pn_selectable_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga8521b0999200c076bf12568ac10fe925">pn_messenger_selectable</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga8521b0999200c076bf12568ac10fe925"><td class="mdescLeft"> </td><td class="mdescRight">Extract selectables from a passive messenger. <a href="group__messenger.html#ga8521b0999200c076bf12568ac10fe925">More...</a><br /></td></tr> |
| <tr class="separator:ga8521b0999200c076bf12568ac10fe925"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga223e7c16f3e84f4e573864c3881b3b4b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__amqp__types.html#gad337c365b498106064ec28e00e5fb6dd">pn_timestamp_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga223e7c16f3e84f4e573864c3881b3b4b">pn_messenger_deadline</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga223e7c16f3e84f4e573864c3881b3b4b"><td class="mdescLeft"> </td><td class="mdescRight">Get the nearest deadline for selectables associated with a messenger. <a href="group__messenger.html#ga223e7c16f3e84f4e573864c3881b3b4b">More...</a><br /></td></tr> |
| <tr class="separator:ga223e7c16f3e84f4e573864c3881b3b4b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gacf39b77df62750343e2f4e90dbcacc75"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gacf39b77df62750343e2f4e90dbcacc75">pn_messenger_set_flags</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const int flags)</td></tr> |
| <tr class="memdesc:gacf39b77df62750343e2f4e90dbcacc75"><td class="mdescLeft"> </td><td class="mdescRight">Sets control flags to enable additional function for the Messenger. <a href="group__messenger.html#gacf39b77df62750343e2f4e90dbcacc75">More...</a><br /></td></tr> |
| <tr class="separator:gacf39b77df62750343e2f4e90dbcacc75"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga9f4e2fbfb7eb7bfd9acd7ad758d24085"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga9f4e2fbfb7eb7bfd9acd7ad758d24085">pn_messenger_get_flags</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger)</td></tr> |
| <tr class="memdesc:ga9f4e2fbfb7eb7bfd9acd7ad758d24085"><td class="mdescLeft"> </td><td class="mdescRight">Gets the flags for a Messenger. <a href="group__messenger.html#ga9f4e2fbfb7eb7bfd9acd7ad758d24085">More...</a><br /></td></tr> |
| <tr class="separator:ga9f4e2fbfb7eb7bfd9acd7ad758d24085"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga7b0872d6712c53e307bf2babfd91bf6e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga7b0872d6712c53e307bf2babfd91bf6e">pn_messenger_set_snd_settle_mode</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const <a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a> mode)</td></tr> |
| <tr class="memdesc:ga7b0872d6712c53e307bf2babfd91bf6e"><td class="mdescLeft"> </td><td class="mdescRight">Set the local sender settle mode for the underlying link. <a href="group__messenger.html#ga7b0872d6712c53e307bf2babfd91bf6e">More...</a><br /></td></tr> |
| <tr class="separator:ga7b0872d6712c53e307bf2babfd91bf6e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae9f2d3ab15602b27f1b87a4f6349a9f1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#gae9f2d3ab15602b27f1b87a4f6349a9f1">pn_messenger_set_rcv_settle_mode</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const <a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a> mode)</td></tr> |
| <tr class="memdesc:gae9f2d3ab15602b27f1b87a4f6349a9f1"><td class="mdescLeft"> </td><td class="mdescRight">Set the local receiver settle mode for the underlying link. <a href="group__messenger.html#gae9f2d3ab15602b27f1b87a4f6349a9f1">More...</a><br /></td></tr> |
| <tr class="separator:gae9f2d3ab15602b27f1b87a4f6349a9f1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga6c2cfb88f59980bb13821a6f25cf30f6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga6c2cfb88f59980bb13821a6f25cf30f6">pn_messenger_set_tracer</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, <a class="el" href="group__transport.html#gae9b49fcbf6397e6916eb4e1357c90ff3">pn_tracer_t</a> tracer)</td></tr> |
| <tr class="memdesc:ga6c2cfb88f59980bb13821a6f25cf30f6"><td class="mdescLeft"> </td><td class="mdescRight">Set the tracer associated with a messenger. <a href="group__messenger.html#ga6c2cfb88f59980bb13821a6f25cf30f6">More...</a><br /></td></tr> |
| <tr class="separator:ga6c2cfb88f59980bb13821a6f25cf30f6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga9be25d57cda5a6e1c5658b0f362c41c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga9be25d57cda5a6e1c5658b0f362c41c7">pn_messenger_get_remote_idle_timeout</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const char *address)</td></tr> |
| <tr class="memdesc:ga9be25d57cda5a6e1c5658b0f362c41c7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the remote idle timeout for the specified remote service address. <a href="group__messenger.html#ga9be25d57cda5a6e1c5658b0f362c41c7">More...</a><br /></td></tr> |
| <tr class="separator:ga9be25d57cda5a6e1c5658b0f362c41c7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga59ebaf21eaafaa4b1c359e4284564ff6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__messenger.html#ga59ebaf21eaafaa4b1c359e4284564ff6">pn_messenger_set_ssl_peer_authentication_mode</a> (<a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> *messenger, const <a class="el" href="group__ssl.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a> mode)</td></tr> |
| <tr class="memdesc:ga59ebaf21eaafaa4b1c359e4284564ff6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the SSL peer authentication mode required when a trust certificate is used. <a href="group__messenger.html#ga59ebaf21eaafaa4b1c359e4284564ff6">More...</a><br /></td></tr> |
| <tr class="separator:ga59ebaf21eaafaa4b1c359e4284564ff6"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <p><b>Deprecated</b> - Use the <a class="el" href="group__proactor.html">Proactor</a> API or Qpid Proton C++. </p> |
| <h2 class="groupheader">Typedef Documentation</h2> |
| <a id="ga0d342bb795d48591ad6b3f867766b8b1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga0d342bb795d48591ad6b3f867766b8b1">◆ </a></span>pn_messenger_t</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef struct <a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> <a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>A <a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1" title="A pn_messenger_t provides a high level interface for sending and receiving messages (See pn_message_t...">pn_messenger_t</a> provides a high level interface for sending and receiving messages (See <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2" title="An AMQP Message object.">pn_message_t</a>). </p> |
| <p>Every messenger contains a single logical queue of incoming messages and a single logical queue of outgoing messages. The messages in these queues may be destined for, or originate from, a variety of addresses.</p> |
| <p>The messenger interface is single-threaded. All methods except one (<a class="el" href="group__messenger.html#ga9da14c67acc17bc5fec6f34e2749534f" title="Interrupt a messenger object that may be blocking in another thread.">pn_messenger_interrupt()</a>) are intended to be used by one thread at a time.</p> |
| <h1><a class="anchor" id="autotoc_md3"></a> |
| Address Syntax</h1> |
| <p>An address has the following form::</p> |
| <p>[ amqp[s]:// ] [user[:password]@] domain [/[name]]</p> |
| <p>Where domain can be one of::</p> |
| <p>host | host:port | ip | ip:port | name</p> |
| <p>The following are valid examples of addresses:</p> |
| <ul> |
| <li>example.org</li> |
| <li>example.org:1234</li> |
| <li>amqp://example.org</li> |
| <li>amqps://example.org</li> |
| <li>example.org/incoming</li> |
| <li>amqps://example.org/outgoing</li> |
| <li>amqps://fred:<a href="#" onclick="location.href='mai'+'lto:'+'tru'+'st'+'no1'+'@e'+'xam'+'pl'+'e.o'+'rg'; return false;">trust<span style="display: none;">.nosp@m.</span>no1@<span style="display: none;">.nosp@m.</span>examp<span style="display: none;">.nosp@m.</span>le.o<span style="display: none;">.nosp@m.</span>rg</a></li> |
| <li>127.0.0.1:1234</li> |
| <li>amqps://127.0.0.1:1234</li> |
| </ul> |
| <h1><a class="anchor" id="autotoc_md4"></a> |
| Sending & Receiving Messages</h1> |
| <p>The messenger API works in conjunction with the <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2" title="An AMQP Message object.">pn_message_t</a> API. A <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2" title="An AMQP Message object.">pn_message_t</a> is a mutable holder of message content.</p> |
| <p>The <a class="el" href="group__messenger.html#gafede68af29484d50d531cc48ab0d3d4a" title="Puts a message onto the messenger's outgoing queue.">pn_messenger_put()</a> operation copies content from the supplied <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2" title="An AMQP Message object.">pn_message_t</a> to the outgoing queue, and may send queued messages if it can do so without blocking. The <a class="el" href="group__messenger.html#gae31f9a99dcbedffe83588cf25b805325" title="Send messages from a messenger's outgoing queue.">pn_messenger_send()</a> operation blocks until it has sent the requested number of messages, or until a timeout interrupts the attempt.</p> |
| <p>pn_messenger_t *messenger = pn_messenger(NULL); pn_message_t *message = <a class="el" href="group__message.html#gaaf98d84b9ddc1c6537dddd4c9c5b979e" title="Construct a new pn_message_t.">pn_message()</a>; char subject[1024]; for (int i = 0; i < 3; i++) { pn_message_set_address(message, "amqp://host/queue"); sprintf(subject, "Hello World! %i", i); pn_message_set_subject(message, subject); pn_messenger_put(messenger, message) pn_messenger_send(messenger);</p> |
| <p>Similarly, the <a class="el" href="group__messenger.html#ga16c945185e4eb5dcb9aac2be2fcab0d6" title="Retrieve messages into a messenger's incoming queue.">pn_messenger_recv()</a> method receives messages into the incoming queue, and may block as it attempts to receive up to the requested number of messages, or until the timeout is reached. It may receive fewer than the requested number. The <a class="el" href="group__messenger.html#gaa6d85929e4b4b574690927ddde00c540" title="Get the next message from the head of a messenger's incoming queue.">pn_messenger_get()</a> method pops the eldest message off the incoming queue and copies its content into the supplied <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2" title="An AMQP Message object.">pn_message_t</a> object. It will not block.</p> |
| <p>pn_messenger_t *messenger = pn_messenger(NULL); pn_message_t *message = <a class="el" href="group__message.html#gaaf98d84b9ddc1c6537dddd4c9c5b979e" title="Construct a new pn_message_t.">pn_message()</a> pn_messenger_recv(messenger): while (pn_messenger_incoming(messenger) > 0) { pn_messenger_get(messenger, message); printf("%s", message.subject); }</p> |
| <p>Output: Hello World 0 Hello World 1 Hello World 2</p> |
| <p>The blocking flag allows you to turn off blocking behavior entirely, in which case <a class="el" href="group__messenger.html#gae31f9a99dcbedffe83588cf25b805325" title="Send messages from a messenger's outgoing queue.">pn_messenger_send()</a> and <a class="el" href="group__messenger.html#ga16c945185e4eb5dcb9aac2be2fcab0d6" title="Retrieve messages into a messenger's incoming queue.">pn_messenger_recv()</a> will do whatever they can without blocking, and then return. You can then look at the number of incoming and outgoing messages to see how much outstanding work still remains.</p> |
| <h1><a class="anchor" id="autotoc_md5"></a> |
| Authentication Mechanisms</h1> |
| <p>The messenger API authenticates using some specific mechanisms. In prior versions of Proton the only authentication mechanism available was the PLAIN mechanism which transports the user's password over the network unencrypted. The Proton versions 0.10 and newer support other more secure mechanisms which avoid sending the users's password over the network unencrypted. For backwards compatibility the 0.10 version of the messenger API will also allow the use of the unencrypted PLAIN mechanism. From the 0.11 version and onwards you will need to set the flag PN_FLAGS_ALLOW_INSECURE_MECHS to carry on using the unencrypted PLAIN mechanism.</p> |
| <p>The code for this looks like:</p> |
| <p>... pn_messenger_set_flags(messenger, PN_FLAGS_ALLOW_INSECURE_MECHS); ...</p> |
| <p>Note that the use of the PLAIN mechanism over an SSL connection is allowed as the password is not sent unencrypted. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Enumeration Type Documentation</h2> |
| <a id="ga242e4ee54b9c0a416443c7da5f6e045b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga242e4ee54b9c0a416443c7da5f6e045b">◆ </a></span>pn_status_t</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="group__messenger.html#ga242e4ee54b9c0a416443c7da5f6e045b">pn_status_t</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Describes all the possible states for a message associated with a given tracker. </p> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga242e4ee54b9c0a416443c7da5f6e045ba0b46b1041679460baaba2ddcdb2173f2"></a>PN_STATUS_UNKNOWN </td><td class="fielddoc"><p>The tracker is unknown. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="gga242e4ee54b9c0a416443c7da5f6e045ba4b0354a77173cd75c69159e15c23f611"></a>PN_STATUS_PENDING </td><td class="fielddoc"><p>The message is in flight. </p> |
| <p>For outgoing messages, use <a class="el" href="group__messenger.html#ga15adeb707f15b86df1e5486c34a060e6" title="Check if the delivery associated with a given tracker is still waiting to be sent.">pn_messenger_buffered</a> to see if it has been sent or not. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="gga242e4ee54b9c0a416443c7da5f6e045ba693fd9044a50a4f02e842d04a4bf1467"></a>PN_STATUS_ACCEPTED </td><td class="fielddoc"><p>The message was accepted. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="gga242e4ee54b9c0a416443c7da5f6e045baf109df703952744009b3547f3b8f32bf"></a>PN_STATUS_REJECTED </td><td class="fielddoc"><p>The message was rejected. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="gga242e4ee54b9c0a416443c7da5f6e045ba67079750477effb7935df83381c47852"></a>PN_STATUS_RELEASED </td><td class="fielddoc"><p>The message was released. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="gga242e4ee54b9c0a416443c7da5f6e045ba77d94a6b6b745eef9307f144b57e81e8"></a>PN_STATUS_MODIFIED </td><td class="fielddoc"><p>The message was modified. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="gga242e4ee54b9c0a416443c7da5f6e045ba1239e8ada7eabe2aeab98f2c881cd2ee"></a>PN_STATUS_ABORTED </td><td class="fielddoc"><p>The message was aborted. </p> |
| </td></tr> |
| <tr><td class="fieldname"><a id="gga242e4ee54b9c0a416443c7da5f6e045ba1181bc7f51502ae11ed240866cd64583"></a>PN_STATUS_SETTLED </td><td class="fielddoc"><p>The remote party has settled the message. </p> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="gabe045d16ca8eb1e3cc87387e2ae82433"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gabe045d16ca8eb1e3cc87387e2ae82433">◆ </a></span>pn_messenger()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a>* pn_messenger </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Construct a new <a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1" title="A pn_messenger_t provides a high level interface for sending and receiving messages (See pn_message_t...">pn_messenger_t</a> with the given name. </p> |
| <p>The name is global. If a NULL name is supplied, a UUID based name will be chosen.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>the name of the messenger or NULL</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>pointer to a new <a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1" title="A pn_messenger_t provides a high level interface for sending and receiving messages (See pn_message_t...">pn_messenger_t</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga71197163a69770575df74e3cee617429"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga71197163a69770575df74e3cee617429">◆ </a></span>pn_messenger_name()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* pn_messenger_name </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the name of a messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the name of the messenger </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gad61fff52c28501171ecbb0b21bbde954"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gad61fff52c28501171ecbb0b21bbde954">◆ </a></span>pn_messenger_set_certificate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_certificate </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>certificate</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the path that will be used to get the certificate that will be used to identify this messenger to its peers. </p> |
| <p>The validity of the path is not checked by this function.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">certificate</td><td>a path to a certificate file </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code of zero if there is no error </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga1d0c003a1fb5e20b894e2deb8b43118b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga1d0c003a1fb5e20b894e2deb8b43118b">◆ </a></span>pn_messenger_get_certificate()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* pn_messenger_get_certificate </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the certificate path. </p> |
| <p>This value may be set by pn_messenger_set_certificate. The default certificate path is null.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the certificate file path </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga05f059a2fe93e0acbcf76e494e6bf958"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga05f059a2fe93e0acbcf76e494e6bf958">◆ </a></span>pn_messenger_set_private_key()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_private_key </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>private_key</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set path to the private key that was used to sign the certificate. </p> |
| <p>See <a class="el" href="group__messenger.html#gad61fff52c28501171ecbb0b21bbde954" title="Sets the path that will be used to get the certificate that will be used to identify this messenger t...">pn_messenger_set_certificate</a></p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">private_key</td><td>a path to a private key file </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code of zero if there is no error </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gab692f989aed2aa83bd71b7fa7196aeb1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gab692f989aed2aa83bd71b7fa7196aeb1">◆ </a></span>pn_messenger_get_private_key()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* pn_messenger_get_private_key </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the private key file for a messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the messenger's private key file path </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga6b04f7dea2ed8752b8672b4cfe0330f2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6b04f7dea2ed8752b8672b4cfe0330f2">◆ </a></span>pn_messenger_set_password()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_password </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>password</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the private key password for a messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">password</td><td>the password for the private key file</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code of zero if there is no error </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga3f02ad7340a59c5982e6223aaeea803a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga3f02ad7340a59c5982e6223aaeea803a">◆ </a></span>pn_messenger_get_password()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* pn_messenger_get_password </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the private key file password for a messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>password for the private key file </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gad901e92e2bee6d5371dcd3b1c8fe2c3b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gad901e92e2bee6d5371dcd3b1c8fe2c3b">◆ </a></span>pn_messenger_set_trusted_certificates()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_trusted_certificates </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>cert_db</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the trusted certificates database for a messenger. </p> |
| <p>The messenger will use this database to validate the certificate provided by the peer.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">cert_db</td><td>a path to the certificates database</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code of zero if there is no error </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga955b218a8f58560e9e228ca14fba21f2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga955b218a8f58560e9e228ca14fba21f2">◆ </a></span>pn_messenger_get_trusted_certificates()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* pn_messenger_get_trusted_certificates </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the trusted certificates database for a messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>path to the trusted certificates database </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga04119bb2b16bb0f657f1dbcf73827d74"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga04119bb2b16bb0f657f1dbcf73827d74">◆ </a></span>pn_messenger_set_timeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_timeout </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>timeout</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the default timeout for a messenger. </p> |
| <p>Any messenger call that blocks during execution will stop blocking and return control when this timeout is reached, if you have set it to a value greater than zero. The timeout is expressed in milliseconds.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>a new timeout for the messenger, in milliseconds </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero if there is no error </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga083ba6296a1ae1dfe45c0fb82da823eb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga083ba6296a1ae1dfe45c0fb82da823eb">◆ </a></span>pn_messenger_get_timeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_get_timeout </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the timeout for a messenger object. </p> |
| <p>See <a class="el" href="group__messenger.html#ga04119bb2b16bb0f657f1dbcf73827d74" title="Set the default timeout for a messenger.">pn_messenger_set_timeout()</a> for details.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the timeout for the messenger, in milliseconds </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gaf572cbf224105d08898d2906336712f7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaf572cbf224105d08898d2906336712f7">◆ </a></span>pn_messenger_is_blocking()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pn_messenger_is_blocking </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check if a messenger is in blocking mode. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if blocking has been enabled, false otherwise </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gae9d7f1aec6e2cf3ef1ee326a4ae15981"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gae9d7f1aec6e2cf3ef1ee326a4ae15981">◆ </a></span>pn_messenger_set_blocking()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_blocking </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>blocking</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Enable or disable blocking behavior for a messenger during calls to <a class="el" href="group__messenger.html#gae31f9a99dcbedffe83588cf25b805325" title="Send messages from a messenger's outgoing queue.">pn_messenger_send</a> and <a class="el" href="group__messenger.html#ga16c945185e4eb5dcb9aac2be2fcab0d6" title="Retrieve messages into a messenger's incoming queue.">pn_messenger_recv</a>. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">blocking</td><td>the value of the blocking flag </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero if there is no error </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga63805c35f18ef041c69a14564dc1bce4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga63805c35f18ef041c69a14564dc1bce4">◆ </a></span>pn_messenger_is_passive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pn_messenger_is_passive </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check if a messenger is in passive mode. </p> |
| <p>A messenger that is in passive mode will never attempt to perform I/O internally, but instead will make all internal file descriptors accessible through <a class="el" href="group__messenger.html#ga8521b0999200c076bf12568ac10fe925" title="Extract selectables from a passive messenger.">pn_messenger_selectable()</a> to be serviced externally. This can be useful for integrating messenger into an external event loop.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the messenger is in passive mode, false otherwise </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gac7df7c92396f10f105ec74d35310a7c0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gac7df7c92396f10f105ec74d35310a7c0">◆ </a></span>pn_messenger_set_passive()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_passive </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>passive</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the passive mode for a messenger. </p> |
| <p>See <a class="el" href="group__messenger.html#ga63805c35f18ef041c69a14564dc1bce4" title="Check if a messenger is in passive mode.">pn_messenger_is_passive()</a> for details on passive mode.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">passive</td><td>true to enable passive mode, false to disable passive mode </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga530295575eda95e3c19316d41bd1baa7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga530295575eda95e3c19316d41bd1baa7">◆ </a></span>pn_messenger_free()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pn_messenger_free </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Frees a Messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger to free (or NULL), no longer valid on return </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="gacfd10311abca28521fe7aa9cabfff61c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gacfd10311abca28521fe7aa9cabfff61c">◆ </a></span>pn_messenger_errno()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_errno </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the code for a messenger's most recent error. </p> |
| <p>The error code is initialized to zero at messenger creation. The error number is "sticky" i.e. error codes are not reset to 0 at the end of successful API calls. You can use <a class="el" href="group__messenger.html#ga0301664be9c54b3a573578776ad2a5d2" title="Get a messenger's error object.">pn_messenger_error</a> to access the messenger's error object and clear explicitly if desired.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger to check for errors </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero if there is no error </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga0301664be9c54b3a573578776ad2a5d2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga0301664be9c54b3a573578776ad2a5d2">◆ </a></span>pn_messenger_error()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__error.html#ga24a289d5b32c9bd8a775600a5af83d52">pn_error_t</a>* pn_messenger_error </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a messenger's error object. </p> |
| <p>Returns a pointer to a pn_error_t that is valid until the messenger is freed. The pn_error_* API allows you to access the text, error number, and lets you set or clear the error code explicitly.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger to check for errors </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a pointer to the messenger's error descriptor </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gac191bdb410b7839d6306a0d8e5ac19e1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gac191bdb410b7839d6306a0d8e5ac19e1">◆ </a></span>pn_messenger_get_outgoing_window()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_get_outgoing_window </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the size of a messenger's outgoing window. </p> |
| <p>The size of the outgoing window limits the number of messages whose status you can check with a tracker. A message enters this window when you call pn_messenger_put on the message. For example, if your outgoing window size is 10, and you call pn_messenger_put 12 times, new status information will no longer be available for the first 2 messages.</p> |
| <p>The default outgoing window size is 0.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the outgoing window for the messenger </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga96487581bd8348f8bc9bacef25042cfc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga96487581bd8348f8bc9bacef25042cfc">◆ </a></span>pn_messenger_set_outgoing_window()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_outgoing_window </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>window</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the size of a messenger's outgoing window. </p> |
| <p>See <a class="el" href="group__messenger.html#gac191bdb410b7839d6306a0d8e5ac19e1" title="Get the size of a messenger's outgoing window.">pn_messenger_get_outgoing_window()</a> for details.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>the number of deliveries to track </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga45d578f39673ad59ca65d2042054abee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga45d578f39673ad59ca65d2042054abee">◆ </a></span>pn_messenger_get_incoming_window()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_get_incoming_window </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the size of a messenger's incoming window. </p> |
| <p>The size of a messenger's incoming window limits the number of messages that can be accepted or rejected using trackers. Messages <em>do not</em> enter this window when they have been received (<a class="el" href="group__messenger.html#ga16c945185e4eb5dcb9aac2be2fcab0d6" title="Retrieve messages into a messenger's incoming queue.">pn_messenger_recv</a>) onto you incoming queue. Messages only enter this window only when you access them using pn_messenger_get. If your incoming window size is N, and you get N+1 messages without explicitly accepting or rejecting the oldest message, then it will be implicitly accepted when it falls off the edge of the incoming window.</p> |
| <p>The default incoming window size is 0.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the incoming window for the messenger </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gadf8a9cf14bf8d519026ea8c4eeb275c3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gadf8a9cf14bf8d519026ea8c4eeb275c3">◆ </a></span>pn_messenger_set_incoming_window()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_incoming_window </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>window</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the size of a messenger's incoming window. </p> |
| <p>See <a class="el" href="group__messenger.html#ga45d578f39673ad59ca65d2042054abee" title="Get the size of a messenger's incoming window.">pn_messenger_get_incoming_window()</a> for details.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">window</td><td>the number of deliveries to track </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga6fa594235e316cd2a04b44b283194a43"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6fa594235e316cd2a04b44b283194a43">◆ </a></span>pn_messenger_start()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_start </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Currently a no-op placeholder. </p> |
| <p>For future compatibility, do not send or receive messages before starting the messenger.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger to start </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gad95ab6daf6b2a61b79d5128a7d1d9f5c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gad95ab6daf6b2a61b79d5128a7d1d9f5c">◆ </a></span>pn_messenger_stop()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_stop </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Stops a messenger. </p> |
| <p>Stopping a messenger will perform an orderly shutdown of all underlying connections. This may require some time. If the messenger is in non blocking mode (see <a class="el" href="group__messenger.html#gaf572cbf224105d08898d2906336712f7" title="Check if a messenger is in blocking mode.">pn_messenger_is_blocking</a>), this operation will return PN_INPROGRESS if it cannot finish immediately. In that case, you can use <a class="el" href="group__messenger.html#gae2c4765839c8fd09c0e01d05a118b6d4" title="Returns true if a messenger is in the stopped state.">pn_messenger_stopped()</a> to determine when the messenger has finished stopping.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger to stop </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gae2c4765839c8fd09c0e01d05a118b6d4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gae2c4765839c8fd09c0e01d05a118b6d4">◆ </a></span>pn_messenger_stopped()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pn_messenger_stopped </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns true if a messenger is in the stopped state. </p> |
| <p>This function does not block.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger to stop </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="gac36589fe5dc0378cf62558e40060a26f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gac36589fe5dc0378cf62558e40060a26f">◆ </a></span>pn_messenger_subscribe()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a>* pn_messenger_subscribe </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>source</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Subscribes a messenger to messages from the specified source. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger to subscribe </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">source</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a subscription </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga480a8623fab904690218c0c67493232f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga480a8623fab904690218c0c67493232f">◆ </a></span>pn_messenger_subscribe_ttl()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a>* pn_messenger_subscribe_ttl </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>source</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__api__types.html#gafdede9be0526a8d0b9ab5d3149069af1">pn_seconds_t</a> </td> |
| <td class="paramname"><em>timeout</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Subscribes a messenger to messages from the specified source with the given timeout for the subscription's lifetime. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger to subscribe </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">source</td><td></td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>the maximum time to keep the subscription alive once the link is closed. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a subscription </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga757aeef23d47ecc2a9a461b882686417"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga757aeef23d47ecc2a9a461b882686417">◆ </a></span>pn_messenger_get_link()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>* pn_messenger_get_link </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>address</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>sender</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a link based on link name and whether the link is a sender or receiver. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger to get the link from </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>the link address that identifies the link to receive </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">sender</td><td>true if the link is a sender, false if the link is a receiver </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a link, or NULL if no link matches the address / sender parameters </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga8ad0f0db6d7cfe0e95d44d433843d787"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga8ad0f0db6d7cfe0e95d44d433843d787">◆ </a></span>pn_subscription_get_context()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void* pn_subscription_get_context </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> * </td> |
| <td class="paramname"><em>sub</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a subscription's application context. </p> |
| <p>See <a class="el" href="group__messenger.html#ga3a7f95a2a86f64babe692d21ffe9cd10" title="Set an application context for a subscription.">pn_subscription_set_context()</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">sub</td><td>a subscription object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the subscription's application context </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga3a7f95a2a86f64babe692d21ffe9cd10"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga3a7f95a2a86f64babe692d21ffe9cd10">◆ </a></span>pn_subscription_set_context()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pn_subscription_set_context </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> * </td> |
| <td class="paramname"><em>sub</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>context</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set an application context for a subscription. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">sub</td><td>a subscription object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>the application context for the subscription </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ga8e87c040776f1941f21d2c15f24b835e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga8e87c040776f1941f21d2c15f24b835e">◆ </a></span>pn_subscription_address()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* pn_subscription_address </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a> * </td> |
| <td class="paramname"><em>sub</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the source address of a subscription. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">sub</td><td>a subscription object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the subscription's source address </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gafede68af29484d50d531cc48ab0d3d4a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gafede68af29484d50d531cc48ab0d3d4a">◆ </a></span>pn_messenger_put()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_put </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> * </td> |
| <td class="paramname"><em>msg</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Puts a message onto the messenger's outgoing queue. </p> |
| <p>The message may also be sent if transmission would not cause blocking. This call will not block.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>a message to put on the messenger's outgoing queue </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gad398544ad1374f67c922115ae1cceacc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gad398544ad1374f67c922115ae1cceacc">◆ </a></span>pn_messenger_status()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__messenger.html#ga242e4ee54b9c0a416443c7da5f6e045b">pn_status_t</a> pn_messenger_status </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> </td> |
| <td class="paramname"><em>tracker</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Track the status of a delivery. </p> |
| <p>Get the current status of the delivery associated with the supplied tracker. This may return PN_STATUS_UNKOWN if the tracker has fallen outside the incoming/outgoing tracking windows of the messenger.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tracker</td><td>the tracker identifying the delivery </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a status code for the delivery </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga65f22122f08bc93de2bfe155aa12d0b0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga65f22122f08bc93de2bfe155aa12d0b0">◆ </a></span>pn_messenger_delivery()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__delivery.html#gacdfce854066c0a4ff4db9f9a0478f340">pn_delivery_t</a>* pn_messenger_delivery </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> </td> |
| <td class="paramname"><em>tracker</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get delivery information about a delivery. </p> |
| <p>Returns the delivery information associated with the supplied tracker. This may return NULL if the tracker has fallen outside the incoming/outgoing tracking windows of the messenger.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tracker</td><td>the tracker identifying the delivery </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a pn_delivery_t representing the delivery. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga15adeb707f15b86df1e5486c34a060e6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga15adeb707f15b86df1e5486c34a060e6">◆ </a></span>pn_messenger_buffered()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool pn_messenger_buffered </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> </td> |
| <td class="paramname"><em>tracker</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check if the delivery associated with a given tracker is still waiting to be sent. </p> |
| <p>Note that returning false does not imply that the delivery was actually sent over the wire.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tracker</td><td>the tracker identifying the delivery</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if the delivery is still buffered </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga475ce593f6b0c6025516ae48360dee4d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga475ce593f6b0c6025516ae48360dee4d">◆ </a></span>pn_messenger_settle()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_settle </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> </td> |
| <td class="paramname"><em>tracker</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Frees a Messenger from tracking the status associated with a given tracker. </p> |
| <p>Use the PN_CUMULATIVE flag to indicate everything up to (and including) the given tracker.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the Messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tracker</td><td>identifies a delivery </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>0 or PN_CUMULATIVE</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga0212b5cfe07a7f758ec472d67d0f56e1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga0212b5cfe07a7f758ec472d67d0f56e1">◆ </a></span>pn_messenger_outgoing_tracker()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> pn_messenger_outgoing_tracker </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a tracker for the outgoing message most recently given to pn_messenger_put. </p> |
| <p>This tracker may be used with pn_messenger_status to determine the delivery status of the message, as long as the message is still within your outgoing window.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a pn_tracker_t or an undefined value if pn_messenger_get has never been called for the given messenger </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga47d60cec6a55e0675b8f073067eff9c4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga47d60cec6a55e0675b8f073067eff9c4">◆ </a></span>pn_messenger_work()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_work </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>timeout</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sends or receives any outstanding messages queued for a messenger. </p> |
| <p>This will block for the indicated timeout.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the Messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td>the maximum time to block in milliseconds, -1 == forever, 0 == do not block</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>0 if no work to do, < 0 if error, or 1 if work was done. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga9da14c67acc17bc5fec6f34e2749534f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga9da14c67acc17bc5fec6f34e2749534f">◆ </a></span>pn_messenger_interrupt()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_interrupt </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Interrupt a messenger object that may be blocking in another thread. </p> |
| <p>The messenger interface is single-threaded. This is the only messenger function intended to be concurrently called from another thread. It will interrupt any messenger function which is currently blocking and cause it to return with a status of <a class="el" href="group__error.html#ga53284958be0c328f90ca3a4a0793d965" title="Interrupt.">PN_INTR</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the Messenger to interrupt </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="gae31f9a99dcbedffe83588cf25b805325"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gae31f9a99dcbedffe83588cf25b805325">◆ </a></span>pn_messenger_send()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_send </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>n</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Send messages from a messenger's outgoing queue. </p> |
| <p>If a messenger is in blocking mode (see <a class="el" href="group__messenger.html#gaf572cbf224105d08898d2906336712f7" title="Check if a messenger is in blocking mode.">pn_messenger_is_blocking()</a>), this operation will block until N messages have been sent from the outgoing queue. A value of -1 for N means "all messages in the outgoing queue". See below for a full definition of what sent from the outgoing queue means.</p> |
| <p>Any blocking will end once the messenger's configured timeout (if any) has been reached. When this happens an error code of <a class="el" href="group__error.html#ga8bcf4aa6de1a6530713839bcae97d4a2" title="Timeout.">PN_TIMEOUT</a> is returned.</p> |
| <p>If the messenger is in non blocking mode, this call will return an error code of <a class="el" href="group__error.html#gafbb090366e9dbf9a5bb0735df1e23d33" title="In-progress.">PN_INPROGRESS</a> if it is unable to send the requested number of messages without blocking.</p> |
| <p>A message is considered to be sent from the outgoing queue when its status has been fully determined. This does not necessarily mean the message was successfully sent to the final recipient though, for example of the receiver rejects the message, the final status will be <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045baf109df703952744009b3547f3b8f32bf" title="The message was rejected.">PN_STATUS_REJECTED</a>. Similarly, if a message is sent to an invalid address, it may be removed from the outgoing queue without ever even being transmitted. In this case the final status will be <a class="el" href="group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba1239e8ada7eabe2aeab98f2c881cd2ee" title="The message was aborted.">PN_STATUS_ABORTED</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>the number of messages to send</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga16c945185e4eb5dcb9aac2be2fcab0d6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga16c945185e4eb5dcb9aac2be2fcab0d6">◆ </a></span>pn_messenger_recv()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_recv </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>limit</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Retrieve messages into a messenger's incoming queue. </p> |
| <p>Instructs a messenger to receive up to <code>limit</code> messages into the incoming message queue of a messenger. If <code>limit</code> is -1, the messenger will receive as many messages as it can buffer internally. If the messenger is in blocking mode, this call will block until at least one message is available in the incoming queue.</p> |
| <p>Each call to pn_messenger_recv replaces the previous receive operation, so pn_messenger_recv(messenger, 0) will cancel any outstanding receive.</p> |
| <p>After receiving messages onto your incoming queue use <a class="el" href="group__messenger.html#gaa6d85929e4b4b574690927ddde00c540" title="Get the next message from the head of a messenger's incoming queue.">pn_messenger_get()</a> to access message content.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">limit</td><td>the maximum number of messages to receive or -1 to to receive as many messages as it can buffer internally. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gaf4e22c8cb1436891d42ca0a658fca9c5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaf4e22c8cb1436891d42ca0a658fca9c5">◆ </a></span>pn_messenger_receiving()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_receiving </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the capacity of the incoming message queue of a messenger. </p> |
| <p>Note this count does not include those messages already available on the incoming queue (</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__messenger.html#ga43cf91b5528c2729b3ff9ae1d2a7d257" title="Get the number of messages in the incoming message queue of a messenger.">pn_messenger_incoming()</a>). Rather it returns the number of incoming queue entries available for receiving messages.</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="gaa6d85929e4b4b574690927ddde00c540"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaa6d85929e4b4b574690927ddde00c540">◆ </a></span>pn_messenger_get()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_get </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2">pn_message_t</a> * </td> |
| <td class="paramname"><em>message</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the next message from the head of a messenger's incoming queue. </p> |
| <p>The get operation copies the message data from the head of the messenger's incoming queue into the provided <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2" title="An AMQP Message object.">pn_message_t</a> object. If provided <a class="el" href="group__message.html#gad9259fa9271e8844c8e05a7e8978e3b2" title="An AMQP Message object.">pn_message_t</a> pointer is NULL, the head message will be discarded. This operation will return <a class="el" href="group__error.html#ga9e0f51b097f94293cdbbdeb5422a27a3" title="End of stream.">PN_EOS</a> if there are no messages left on the incoming queue.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">message</td><td>upon return contains the message from the head of the queue </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gafe31e771826f8107d93fc276c9715aab"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gafe31e771826f8107d93fc276c9715aab">◆ </a></span>pn_messenger_incoming_tracker()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> pn_messenger_incoming_tracker </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get a tracker for the message most recently retrieved by <a class="el" href="group__messenger.html#gaa6d85929e4b4b574690927ddde00c540" title="Get the next message from the head of a messenger's incoming queue.">pn_messenger_get()</a>. </p> |
| <p>A tracker for an incoming message allows you to accept or reject the associated message. It can also be used for cumulative accept/reject operations for the associated message and all prior messages as well.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a pn_tracker_t or an undefined value if pn_messenger_get has never been called for the given messenger </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gae351d031d2ef29bdb137a59d461c4253"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gae351d031d2ef29bdb137a59d461c4253">◆ </a></span>pn_messenger_incoming_subscription()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__messenger.html#gabd73703511b9dae193765e9e57864291">pn_subscription_t</a>* pn_messenger_incoming_subscription </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the subscription of the message most recently retrieved by <a class="el" href="group__messenger.html#gaa6d85929e4b4b574690927ddde00c540" title="Get the next message from the head of a messenger's incoming queue.">pn_messenger_get()</a>. </p> |
| <p>This operation will return NULL if <a class="el" href="group__messenger.html#gaa6d85929e4b4b574690927ddde00c540" title="Get the next message from the head of a messenger's incoming queue.">pn_messenger_get()</a> has never been successfully called.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a pn_subscription_t or NULL </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga11cd0d3423482e1ddda7a8b0cbb581c7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga11cd0d3423482e1ddda7a8b0cbb581c7">◆ </a></span>pn_messenger_accept()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_accept </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> </td> |
| <td class="paramname"><em>tracker</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Signal successful processing of message(s). </p> |
| <p>With no flags this operation will signal the sender that the message referenced by the tracker was accepted. If the PN_CUMULATIVE flag is set, this operation will also reject all pending messages prior to the message indicated by the tracker.</p> |
| <p>Note that when a message is accepted or rejected multiple times, either explicitly, or implicitly through use of the <a class="el" href="group__messenger.html#ga6c2e8d006ec05b913fa1e6dc510d23b9" title="Indicates that an accept or reject should operate cumulatively.">PN_CUMULATIVE</a> flag, only the first outcome applies. For example if a sequence of three messages are received: M1, M2, M3, and M2 is rejected, and M3 is cumulatively accepted, M2 will remain rejected and only M1 and M3 will be considered accepted.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tracker</td><td>an incoming tracker </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>0 or PN_CUMULATIVE </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga22d6de108fa967a43ab2473d6a915e9c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga22d6de108fa967a43ab2473d6a915e9c">◆ </a></span>pn_messenger_reject()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_reject </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> </td> |
| <td class="paramname"><em>tracker</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Signal unsuccessful processing of message(s). </p> |
| <p>With no flags this operation will signal the sender that the message indicated by the tracker was rejected. If the PN_CUMULATIVE flag is used this operation will also reject all pending messages prior to the message indicated by the tracker.</p> |
| <p>Note that when a message is accepted or rejected multiple times, either explicitly, or implicitly through use of the <a class="el" href="group__messenger.html#ga6c2e8d006ec05b913fa1e6dc510d23b9" title="Indicates that an accept or reject should operate cumulatively.">PN_CUMULATIVE</a> flag, only the first outcome applies. For example if a sequence of three messages are received: M1, M2, M3, and M2 is accepted, and M3 is cumulatively rejected, M2 will remain accepted and only M1 and M3 will be considered rejected.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tracker</td><td>an incoming tracker </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>0 or PN_CUMULATIVE </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gae4e5e89c6ea2a820a221af61cc741c7d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gae4e5e89c6ea2a820a221af61cc741c7d">◆ </a></span>pn_messenger_tracker_link()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__link.html#ga89dad3aa7934329a7ff467c636687bc0">pn_link_t</a>* pn_messenger_tracker_link </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7">pn_tracker_t</a> </td> |
| <td class="paramname"><em>tracker</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get link for the message referenced by the given tracker. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tracker</td><td>a tracker object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>a pn_link_t or NULL if the link could not be determined. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga06c3a066422f8a966523b43a61f62eb9"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga06c3a066422f8a966523b43a61f62eb9">◆ </a></span>pn_messenger_outgoing()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_outgoing </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the number of messages in the outgoing message queue of a messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the outgoing queue depth </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga43cf91b5528c2729b3ff9ae1d2a7d257"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga43cf91b5528c2729b3ff9ae1d2a7d257">◆ </a></span>pn_messenger_incoming()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_incoming </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the number of messages in the incoming message queue of a messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the incoming queue depth </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga6c85a08d72ae73a18f9fb64ccf0c470e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6c85a08d72ae73a18f9fb64ccf0c470e">◆ </a></span>pn_messenger_route()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_route </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>pattern</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>address</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds a routing rule to a Messenger's internal routing table. </p> |
| <p>The route procedure may be used to influence how a messenger will internally treat a given address or class of addresses. Every call to the route procedure will result in messenger appending a routing rule to its internal routing table.</p> |
| <p>Whenever a message is presented to a messenger for delivery, it will match the address of this message against the set of routing rules in order. The first rule to match will be triggered, and instead of routing based on the address presented in the message, the messenger will route based on the address supplied in the rule.</p> |
| <p>The pattern matching syntax supports two types of matches, a '' will match any character except a '/', and a '*' will match any character including a '/'.</p> |
| <p>A routing address is specified as a normal AMQP address, however it may additionally use substitution variables from the pattern match that triggered the rule.</p> |
| <p>Any message sent to "foo" will be routed to "amqp://foo.com":</p> |
| <p>pn_messenger_route("foo", "amqp://foo.com");</p> |
| <p>Any message sent to "foobar" will be routed to "amqp://foo.com/bar":</p> |
| <p>pn_messenger_route("foobar", "amqp://foo.com/bar");</p> |
| <p>Any message sent to bar/<path> will be routed to the corresponding path within the amqp://bar.com domain:</p> |
| <p>pn_messenger_route("bar/*", "amqp://bar.com/$1");</p> |
| <p>Route all messages over TLS:</p> |
| <p>pn_messenger_route("amqp:*", "amqps:$1")</p> |
| <p>Supply credentials for foo.com:</p> |
| <p>pn_messenger_route("amqp://foo.com/*", "amqp://user:password@foo.com/$1");</p> |
| <p>Supply credentials for all domains:</p> |
| <p>pn_messenger_route("amqp://*", "amqp://user:password@$1");</p> |
| <p>Route all addresses through a single proxy while preserving the original destination:</p> |
| <p>pn_messenger_route("amqp://%/*", "amqp://user:password@proxy/$1/$2");</p> |
| <p>Route any address through a single broker:</p> |
| <p>pn_messenger_route("*", "amqp://user:password@broker/$1");</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the Messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">pattern</td><td>a glob pattern </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>an address indicating alternative routing</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="error_8h.html" title="A Proton API error.">error.h</a> </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gac7dc5d9b82f9e015fd2c7d9743099eff"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gac7dc5d9b82f9e015fd2c7d9743099eff">◆ </a></span>pn_messenger_rewrite()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_rewrite </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>pattern</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>address</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Rewrite message addresses prior to transmission. </p> |
| <p>This operation is similar to pn_messenger_route, except that the destination of the message is determined before the message address is rewritten.</p> |
| <p>The outgoing address is only rewritten after routing has been finalized. If a message has an outgoing address of "amqp://0.0.0.0:5678", and a rewriting rule that changes its outgoing address to "foo", it will still arrive at the peer that is listening on "amqp://0.0.0.0:5678", but when it arrives there, the receiver will see its outgoing address as "foo".</p> |
| <p>The default rewrite rule removes username and password from addresses before they are transmitted.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">pattern</td><td>a glob pattern to select messages </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>an address indicating outgoing address rewrite </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code or zero on success </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga8521b0999200c076bf12568ac10fe925"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga8521b0999200c076bf12568ac10fe925">◆ </a></span>pn_messenger_selectable()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">pn_selectable_t* pn_messenger_selectable </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Extract selectables from a passive messenger. </p> |
| <p>A messenger that is in passive mode (see <a class="el" href="group__messenger.html#ga63805c35f18ef041c69a14564dc1bce4" title="Check if a messenger is in passive mode.">pn_messenger_is_passive()</a>) will never attempt to perform any I/O internally, but instead make its internal file descriptors available for external processing via the <a class="el" href="group__messenger.html#ga8521b0999200c076bf12568ac10fe925" title="Extract selectables from a passive messenger.">pn_messenger_selectable()</a> operation.</p> |
| <p>An application wishing to perform I/O on behalf of a passive messenger must extract all available selectables by calling this operation until it returns NULL. The selectable interface may then be used by the application to perform I/O outside the messenger.</p> |
| <p>All selectables returned by this operation must be serviced until they reach a terminal state and then freed. See <code>pn_selectable_is_terminal()</code> for more details.</p> |
| <p>By default any given selectable will only ever be returned once by this operation, however if the selectable's registered flag is set to true (see <code>pn_selectable_set_registered()</code>), then the selectable will be returned whenever its interest set may have changed.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the next selectable, or NULL if there are none left </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga223e7c16f3e84f4e573864c3881b3b4b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga223e7c16f3e84f4e573864c3881b3b4b">◆ </a></span>pn_messenger_deadline()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__amqp__types.html#gad337c365b498106064ec28e00e5fb6dd">pn_timestamp_t</a> pn_messenger_deadline </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the nearest deadline for selectables associated with a messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the nearest deadline </dd></dl> |
| |
| </div> |
| </div> |
| <a id="gacf39b77df62750343e2f4e90dbcacc75"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gacf39b77df62750343e2f4e90dbcacc75">◆ </a></span>pn_messenger_set_flags()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_flags </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const int </td> |
| <td class="paramname"><em>flags</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets control flags to enable additional function for the Messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>0 or PN_FLAGS_CHECK_ROUTES</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>an error code of zero if there is no error </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga9f4e2fbfb7eb7bfd9acd7ad758d24085"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga9f4e2fbfb7eb7bfd9acd7ad758d24085">◆ </a></span>pn_messenger_get_flags()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_get_flags </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the flags for a Messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The flags set for the messenger </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga7b0872d6712c53e307bf2babfd91bf6e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga7b0872d6712c53e307bf2babfd91bf6e">◆ </a></span>pn_messenger_set_snd_settle_mode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_snd_settle_mode </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="group__link.html#ga3fb58bd0b88d37407ebb615c2630e608">pn_snd_settle_mode_t</a> </td> |
| <td class="paramname"><em>mode</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the local sender settle mode for the underlying link. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the sender settle mode </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="gae9f2d3ab15602b27f1b87a4f6349a9f1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gae9f2d3ab15602b27f1b87a4f6349a9f1">◆ </a></span>pn_messenger_set_rcv_settle_mode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_rcv_settle_mode </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="group__link.html#gad1c2388cdae687be26222a5d66fd2d58">pn_rcv_settle_mode_t</a> </td> |
| <td class="paramname"><em>mode</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the local receiver settle mode for the underlying link. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>the messenger </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the receiver settle mode </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ga6c2cfb88f59980bb13821a6f25cf30f6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6c2cfb88f59980bb13821a6f25cf30f6">◆ </a></span>pn_messenger_set_tracer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void pn_messenger_set_tracer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__transport.html#gae9b49fcbf6397e6916eb4e1357c90ff3">pn_tracer_t</a> </td> |
| <td class="paramname"><em>tracer</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Set the tracer associated with a messenger. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">tracer</td><td>the tracer callback </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ga9be25d57cda5a6e1c5658b0f362c41c7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga9be25d57cda5a6e1c5658b0f362c41c7">◆ </a></span>pn_messenger_get_remote_idle_timeout()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="group__api__types.html#ga9a701bc6dc9af9f42c3f4679172a723c">pn_millis_t</a> pn_messenger_get_remote_idle_timeout </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>address</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Gets the remote idle timeout for the specified remote service address. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>of remote service whose idle timeout is required </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the timeout in milliseconds or -1 if an error occurs </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga59ebaf21eaafaa4b1c359e4284564ff6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga59ebaf21eaafaa4b1c359e4284564ff6">◆ </a></span>pn_messenger_set_ssl_peer_authentication_mode()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int pn_messenger_set_ssl_peer_authentication_mode </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1">pn_messenger_t</a> * </td> |
| <td class="paramname"><em>messenger</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="group__ssl.html#gae5e33024ed6af3432d4c76d1484d7ecb">pn_ssl_verify_mode_t</a> </td> |
| <td class="paramname"><em>mode</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the SSL peer authentication mode required when a trust certificate is used. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">messenger</td><td>a messenger object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>the mode required (see pn_ssl_verify_mode_t enum for valid values) </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>0 if successful or -1 if an error occurs </dd></dl> |
| |
| </div> |
| </div> |
| </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.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
