blob: 8d9e93b032ebc7d8b43c0ce1ac763e89763e8134 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C API: proton/listener.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Qpid Proton C API
&#160;<span id="projectnumber">0.32.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('listener_8h.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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">listener.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><b>Unsettled API</b> - A listener for incoming connections.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;proton/import_export.h&gt;</code><br />
<code>#include &lt;<a class="el" href="types_8h_source.html">proton/types.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="event_8h_source.html">proton/event.h</a>&gt;</code><br />
</div>
<p><a href="listener_8h_source.html">Go to the source code of this file.</a></p>
<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> *&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:gaf5769baf81fdfa80e5c4326dd4a9ab63"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ga3719a4ab17b8de42fc6bfb262018d070"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ga8a100386ab4a079ae6924aeaafc72eb9"><td class="memItemLeft" align="right" valign="top">
PNP_EXTERN void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:gaa49d0d11a9f46a75fbbbebf6def2d4b2"><td class="memItemLeft" align="right" valign="top">
PNP_EXTERN <a class="el" href="group__condition.html#ga11eb7db7d2c205169fe3d47c996a95a5">pn_condition_t</a> *&#160;</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">&#160;</td><td class="mdescRight">Get the error condition for a listener. <br /></td></tr>
<tr class="separator:gaa49d0d11a9f46a75fbbbebf6def2d4b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4690dd0157850a2930bdf443a0251967"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void *&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ga109e764750a7ccddd48879bb29071216"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:gae94f2acd3463fc0a42b1b5dd68d9326f"><td class="memItemLeft" align="right" valign="top">
PNP_EXTERN pn_record_t *&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ga17a5b8573f00e16b233c59a3bb17c104"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ga994a35d101824296c6e6077f2a74ff61"><td class="memItemLeft" align="right" valign="top">
PNP_EXTERN <a class="el" href="group__proactor.html#gabba42c7929dfceb9d296535bad0c93dc">pn_proactor_t</a> *&#160;</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">&#160;</td><td class="mdescRight">The proactor associated with a listener. <br /></td></tr>
<tr class="separator:ga994a35d101824296c6e6077f2a74ff61"><td class="memSeparator" colspan="2">&#160;</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> *&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:gaa85081d87210d85a304cbf5a0203dc79"><td class="memItemLeft" align="right" valign="top">PNP_EXTERN void&#160;</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">&#160;</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">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><b>Unsettled API</b> - A listener for incoming connections. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_3a71568e5d046e5ed52679664c3002a5.html">proton</a></li><li class="navelem"><a class="el" href="listener_8h.html">listener.h</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>