| <!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: Listener</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__listener.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="#typedef-members">Typedefs</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">Listener<div class="ingroups"><a class="el" href="group__io.html">IO</a></div></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><b>Unsettled API</b> - A listener for incoming connections. |
| <a href="#details">More...</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> |
| Typedefs</h2></td></tr> |
| <tr class="memitem:ga68ac7072ae60612d0bca5470014bf216"><td class="memItemLeft" align="right" valign="top"><a id="ga68ac7072ae60612d0bca5470014bf216"></a> |
| typedef struct <a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a></td></tr> |
| <tr class="memdesc:ga68ac7072ae60612d0bca5470014bf216"><td class="mdescLeft"> </td><td class="mdescRight">A listener for incoming connections. <br /></td></tr> |
| <tr class="separator:ga68ac7072ae60612d0bca5470014bf216"><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:gabba0a7d2e916188e3ec07d0acf8f3fc5"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#gabba0a7d2e916188e3ec07d0acf8f3fc5">pn_listener</a> (void)</td></tr> |
| <tr class="memdesc:gabba0a7d2e916188e3ec07d0acf8f3fc5"><td class="mdescLeft"> </td><td class="mdescRight">Create a listener to pass to <a class="el" href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752" title="Start listening for incoming connections.">pn_proactor_listen()</a> <a href="group__listener.html#gabba0a7d2e916188e3ec07d0acf8f3fc5">More...</a><br /></td></tr> |
| <tr class="separator:gabba0a7d2e916188e3ec07d0acf8f3fc5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaf5769baf81fdfa80e5c4326dd4a9ab63"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#gaf5769baf81fdfa80e5c4326dd4a9ab63">pn_listener_free</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *l)</td></tr> |
| <tr class="memdesc:gaf5769baf81fdfa80e5c4326dd4a9ab63"><td class="mdescLeft"> </td><td class="mdescRight">Free a listener. <a href="group__listener.html#gaf5769baf81fdfa80e5c4326dd4a9ab63">More...</a><br /></td></tr> |
| <tr class="separator:gaf5769baf81fdfa80e5c4326dd4a9ab63"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3719a4ab17b8de42fc6bfb262018d070"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga3719a4ab17b8de42fc6bfb262018d070">pn_listener_accept2</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection, <a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> *transport)</td></tr> |
| <tr class="memdesc:ga3719a4ab17b8de42fc6bfb262018d070"><td class="mdescLeft"> </td><td class="mdescRight">Accept an incoming connection request using <code>transport</code> and <code>connection</code>, which can be configured before the call. <a href="group__listener.html#ga3719a4ab17b8de42fc6bfb262018d070">More...</a><br /></td></tr> |
| <tr class="separator:ga3719a4ab17b8de42fc6bfb262018d070"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga8a100386ab4a079ae6924aeaafc72eb9"><td class="memItemLeft" align="right" valign="top"><a id="ga8a100386ab4a079ae6924aeaafc72eb9"></a> |
| PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga8a100386ab4a079ae6924aeaafc72eb9">pn_listener_accept</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, <a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> *connection)</td></tr> |
| <tr class="memdesc:ga8a100386ab4a079ae6924aeaafc72eb9"><td class="mdescLeft"> </td><td class="mdescRight"><b>Deprecated</b> - Use <a class="el" href="group__listener.html#ga3719a4ab17b8de42fc6bfb262018d070" title="Accept an incoming connection request using transport and connection, which can be configured before ...">pn_listener_accept2()</a>. <br /></td></tr> |
| <tr class="separator:ga8a100386ab4a079ae6924aeaafc72eb9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaa49d0d11a9f46a75fbbbebf6def2d4b2"><td class="memItemLeft" align="right" valign="top"><a id="gaa49d0d11a9f46a75fbbbebf6def2d4b2"></a> |
| PNP_EXTERN <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#gaa49d0d11a9f46a75fbbbebf6def2d4b2">pn_listener_condition</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *l)</td></tr> |
| <tr class="memdesc:gaa49d0d11a9f46a75fbbbebf6def2d4b2"><td class="mdescLeft"> </td><td class="mdescRight">Get the error condition for a listener. <br /></td></tr> |
| <tr class="separator:gaa49d0d11a9f46a75fbbbebf6def2d4b2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga4690dd0157850a2930bdf443a0251967"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga4690dd0157850a2930bdf443a0251967">pn_listener_get_context</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener)</td></tr> |
| <tr class="memdesc:ga4690dd0157850a2930bdf443a0251967"><td class="mdescLeft"> </td><td class="mdescRight">Get the application context associated with this listener object. <a href="group__listener.html#ga4690dd0157850a2930bdf443a0251967">More...</a><br /></td></tr> |
| <tr class="separator:ga4690dd0157850a2930bdf443a0251967"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga109e764750a7ccddd48879bb29071216"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga109e764750a7ccddd48879bb29071216">pn_listener_set_context</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, void *context)</td></tr> |
| <tr class="memdesc:ga109e764750a7ccddd48879bb29071216"><td class="mdescLeft"> </td><td class="mdescRight">Set a new application context for a listener object. <a href="group__listener.html#ga109e764750a7ccddd48879bb29071216">More...</a><br /></td></tr> |
| <tr class="separator:ga109e764750a7ccddd48879bb29071216"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae94f2acd3463fc0a42b1b5dd68d9326f"><td class="memItemLeft" align="right" valign="top"><a id="gae94f2acd3463fc0a42b1b5dd68d9326f"></a> |
| PNP_EXTERN pn_record_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#gae94f2acd3463fc0a42b1b5dd68d9326f">pn_listener_attachments</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener)</td></tr> |
| <tr class="memdesc:gae94f2acd3463fc0a42b1b5dd68d9326f"><td class="mdescLeft"> </td><td class="mdescRight">Get the attachments that are associated with a listener object. <br /></td></tr> |
| <tr class="separator:gae94f2acd3463fc0a42b1b5dd68d9326f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga17a5b8573f00e16b233c59a3bb17c104"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga17a5b8573f00e16b233c59a3bb17c104">pn_listener_close</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *l)</td></tr> |
| <tr class="memdesc:ga17a5b8573f00e16b233c59a3bb17c104"><td class="mdescLeft"> </td><td class="mdescRight">Close the listener. <a href="group__listener.html#ga17a5b8573f00e16b233c59a3bb17c104">More...</a><br /></td></tr> |
| <tr class="separator:ga17a5b8573f00e16b233c59a3bb17c104"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga994a35d101824296c6e6077f2a74ff61"><td class="memItemLeft" align="right" valign="top"><a id="ga994a35d101824296c6e6077f2a74ff61"></a> |
| PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga994a35d101824296c6e6077f2a74ff61">pn_listener_proactor</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *c)</td></tr> |
| <tr class="memdesc:ga994a35d101824296c6e6077f2a74ff61"><td class="mdescLeft"> </td><td class="mdescRight">The proactor associated with a listener. <br /></td></tr> |
| <tr class="separator:ga994a35d101824296c6e6077f2a74ff61"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga6214da9323c8e6fcec8badc57a82e9df"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN <a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#ga6214da9323c8e6fcec8badc57a82e9df">pn_event_listener</a> (<a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> *event)</td></tr> |
| <tr class="memdesc:ga6214da9323c8e6fcec8badc57a82e9df"><td class="mdescLeft"> </td><td class="mdescRight">Return the listener associated with an event. <a href="group__listener.html#ga6214da9323c8e6fcec8badc57a82e9df">More...</a><br /></td></tr> |
| <tr class="separator:ga6214da9323c8e6fcec8badc57a82e9df"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaa85081d87210d85a304cbf5a0203dc79"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__listener.html#gaa85081d87210d85a304cbf5a0203dc79">pn_listener_raw_accept</a> (<a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> *listener, <a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> *raw_connection)</td></tr> |
| <tr class="memdesc:gaa85081d87210d85a304cbf5a0203dc79"><td class="mdescLeft"> </td><td class="mdescRight">Accept an incoming connection request as a raw connection. <a href="group__listener.html#gaa85081d87210d85a304cbf5a0203dc79">More...</a><br /></td></tr> |
| <tr class="separator:gaa85081d87210d85a304cbf5a0203dc79"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <p><b>Unsettled API</b> - A listener for incoming connections. </p> |
| <dl class="section note"><dt>Note</dt><dd>Thread safety: Listener has the same thread-safety rules as a <a class="el" href="group__core.html">Core</a> object. Calls to a single listener must be serialized with the exception of <a class="el" href="group__listener.html#ga17a5b8573f00e16b233c59a3bb17c104" title="Close the listener.">pn_listener_close()</a>. </dd></dl> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="gabba0a7d2e916188e3ec07d0acf8f3fc5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gabba0a7d2e916188e3ec07d0acf8f3fc5">◆ </a></span>pn_listener()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PNP_EXTERN <a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a>* pn_listener </td> |
| <td>(</td> |
| <td class="paramtype">void </td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a listener to pass to <a class="el" href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752" title="Start listening for incoming connections.">pn_proactor_listen()</a> </p> |
| <p>You can use <a class="el" href="group__listener.html#gae94f2acd3463fc0a42b1b5dd68d9326f" title="Get the attachments that are associated with a listener object.">pn_listener_attachments()</a> to set application data that can be accessed when accepting connections. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8c-example.html#a102">broker.c</a>, and <a class="el" href="direct_8c-example.html#a95">direct.c</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="gaf5769baf81fdfa80e5c4326dd4a9ab63"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaf5769baf81fdfa80e5c4326dd4a9ab63">◆ </a></span>pn_listener_free()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PNP_EXTERN void pn_listener_free </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td> |
| <td class="paramname"><em>l</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Free a listener. </p> |
| <p>You don't need to call this unless you create a listener with pn_listen() but never pass it to <a class="el" href="group__proactor.html#gacbed6a4ab75ef8452c10d52e4cd62752" title="Start listening for incoming connections.">pn_proactor_listen()</a> </p> |
| |
| </div> |
| </div> |
| <a id="ga3719a4ab17b8de42fc6bfb262018d070"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga3719a4ab17b8de42fc6bfb262018d070">◆ </a></span>pn_listener_accept2()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PNP_EXTERN void pn_listener_accept2 </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td> |
| <td class="paramname"><em>listener</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__connection.html#ga886351d81ff3a977a284a206526c5aff">pn_connection_t</a> * </td> |
| <td class="paramname"><em>connection</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__transport.html#gac26eda05f649bbf0399f3d8d78d12fa8">pn_transport_t</a> * </td> |
| <td class="paramname"><em>transport</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Accept an incoming connection request using <code>transport</code> and <code>connection</code>, which can be configured before the call. </p> |
| <p>Call after a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa0602b15957883e7d00ccdff4abca992c">PN_LISTENER_ACCEPT</a> event.</p> |
| <p>Errors are returned as <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1ca722ce3c0b2c13a33636cded8430ba">PN_TRANSPORT_CLOSED</a> events by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle.">pn_proactor_wait()</a>.</p> |
| <dl class="section note"><dt>Note</dt><dd>If you provide a transport, <a class="el" href="group__listener.html#ga3719a4ab17b8de42fc6bfb262018d070" title="Accept an incoming connection request using transport and connection, which can be configured before ...">pn_listener_accept2()</a> will call <a class="el" href="group__transport.html#gac5bebd26c0942bc17d7fad36577110f8" title="Configure a transport as a server.">pn_transport_set_server()</a> to mark it as a server. However if you use <a class="el" href="group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c" title="Construct an Authentication and Security Layer object.">pn_sasl()</a> you <em>must</em> call call <a class="el" href="group__transport.html#gac5bebd26c0942bc17d7fad36577110f8" title="Configure a transport as a server.">pn_transport_set_server()</a> yourself <em>before</em> calling <a class="el" href="group__sasl.html#ga7968e80e2fe9360fc14cf865dd1ac21c" title="Construct an Authentication and Security Layer object.">pn_sasl()</a> to set up a server SASL configuration.</dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">listener</td><td>the listener </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">connection</td><td>If NULL a new connection is created. Memory management is the same as for <a class="el" href="group__proactor.html#gabb093e51449351cf5530bb300bd67ba1" title="Connect transport to addr and bind to connection.">pn_proactor_connect2()</a> </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">transport</td><td>If NULL a new transport is created. Memory management is the same as for <a class="el" href="group__proactor.html#gabb093e51449351cf5530bb300bd67ba1" title="Connect transport to addr and bind to connection.">pn_proactor_connect2()</a> </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8c-example.html#a41">broker.c</a>, and <a class="el" href="direct_8c-example.html#a57">direct.c</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ga4690dd0157850a2930bdf443a0251967"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga4690dd0157850a2930bdf443a0251967">◆ </a></span>pn_listener_get_context()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PNP_EXTERN void* pn_listener_get_context </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td> |
| <td class="paramname"><em>listener</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get the application context associated with this listener object. </p> |
| <p>The application context for a connection may be set using <a class="el" href="group__listener.html#ga109e764750a7ccddd48879bb29071216" title="Set a new application context for a listener object.">pn_listener_set_context</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">listener</td><td>the listener whose context is to be returned. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>the application context for the listener object </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ga109e764750a7ccddd48879bb29071216"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga109e764750a7ccddd48879bb29071216">◆ </a></span>pn_listener_set_context()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PNP_EXTERN void pn_listener_set_context </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td> |
| <td class="paramname"><em>listener</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 a new application context for a listener object. </p> |
| <p>The application context for a listener object may be retrieved using <a class="el" href="group__listener.html#ga4690dd0157850a2930bdf443a0251967" title="Get the application context associated with this listener object.">pn_listener_get_context</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">listener</td><td>the listener object </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>the application context </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ga17a5b8573f00e16b233c59a3bb17c104"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga17a5b8573f00e16b233c59a3bb17c104">◆ </a></span>pn_listener_close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PNP_EXTERN void pn_listener_close </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td> |
| <td class="paramname"><em>l</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Close the listener. </p> |
| <p>The PN_LISTENER_CLOSE event is generated when the listener has stopped listening.</p> |
| <dl class="section note"><dt>Note</dt><dd>Thread safe. Must not be called after the PN_LISTENER_CLOSE event has been handled as the listener may be freed . </dd></dl> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="direct_8c-example.html#a2">direct.c</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ga6214da9323c8e6fcec8badc57a82e9df"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6214da9323c8e6fcec8badc57a82e9df">◆ </a></span>pn_event_listener()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PNP_EXTERN <a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a>* pn_event_listener </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__event.html#ga87f3028b4888632bbd56fb71ac737ae8">pn_event_t</a> * </td> |
| <td class="paramname"><em>event</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return the listener associated with an event. </p> |
| <dl class="section return"><dt>Returns</dt><dd>NULL if the event is not associated with a listener. </dd></dl> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8c-example.html#a32">broker.c</a>, and <a class="el" href="direct_8c-example.html#a55">direct.c</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="gaa85081d87210d85a304cbf5a0203dc79"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaa85081d87210d85a304cbf5a0203dc79">◆ </a></span>pn_listener_raw_accept()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">PNP_EXTERN void pn_listener_raw_accept </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__listener.html#ga68ac7072ae60612d0bca5470014bf216">pn_listener_t</a> * </td> |
| <td class="paramname"><em>listener</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="group__raw__connection.html#ga771f248632968276665fb90245023e86">pn_raw_connection_t</a> * </td> |
| <td class="paramname"><em>raw_connection</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Accept an incoming connection request as a raw connection. </p> |
| <p>Call after a <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa0602b15957883e7d00ccdff4abca992c">PN_LISTENER_ACCEPT</a> event.</p> |
| <p>Errors are returned as <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1278d8c62c5bf1a46f70b1cb2866ab80">PN_RAW_CONNECTION_DISCONNECTED</a> by <a class="el" href="group__proactor.html#ga2b66a46f3e557010ec61bd105326753d" title="Wait until there are Proactor events to handle.">pn_proactor_wait()</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">listener</td><td>the listener </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">raw_connection</td><td>the application must create a raw connection with <a class="el" href="group__raw__connection.html#gaae8e5b4a86a4f025ece3c3e424ac585d" title="Create a new raw connection for use with the Proactor.">pn_raw_connection()</a> this parameter cannot be null.If NULL a new connection is created.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The proactor that owns the <code>listener</code> <em>takes ownership</em> of <code>raw_connection</code> and will automatically call pn_raw_connection_free() after the final <a class="el" href="group__event.html#gga4876e2eed24a4d4e4c52b99842103cdaa1278d8c62c5bf1a46f70b1cb2866ab80">PN_RAW_CONNECTION_DISCONNECTED</a> event is handled, or when <a class="el" href="group__proactor.html#ga5260c2653d4af5eb2f1c8c6190e9d6cf" title="Free the proactor.">pn_proactor_free()</a> is called. </p> |
| |
| </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> |
