| <!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('classproton_1_1listener.html',''); initResizable(); }); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classproton_1_1listener-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">listener</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A listener for incoming connections. |
| <a href="classproton_1_1listener.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="listener_8hpp_source.html">listener.hpp</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a59dc4506a73a3d4ae084b5fc1d014814"><td class="memItemLeft" align="right" valign="top"><a id="a59dc4506a73a3d4ae084b5fc1d014814"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listener.html#a59dc4506a73a3d4ae084b5fc1d014814">listener</a> ()</td></tr> |
| <tr class="memdesc:a59dc4506a73a3d4ae084b5fc1d014814"><td class="mdescLeft"> </td><td class="mdescRight">Create an empty listener. <br /></td></tr> |
| <tr class="separator:a59dc4506a73a3d4ae084b5fc1d014814"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3edec85cbcde06b471e8e2fb4726dbf5"><td class="memItemLeft" align="right" valign="top"><a id="a3edec85cbcde06b471e8e2fb4726dbf5"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listener.html#a3edec85cbcde06b471e8e2fb4726dbf5">listener</a> (const <a class="el" href="classproton_1_1listener.html">listener</a> &)</td></tr> |
| <tr class="memdesc:a3edec85cbcde06b471e8e2fb4726dbf5"><td class="mdescLeft"> </td><td class="mdescRight">Copy a listener. <br /></td></tr> |
| <tr class="separator:a3edec85cbcde06b471e8e2fb4726dbf5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a426fa804e3bb58ef90b29b066c3f5199"><td class="memItemLeft" align="right" valign="top"><a id="a426fa804e3bb58ef90b29b066c3f5199"></a> |
| <a class="el" href="classproton_1_1listener.html">listener</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listener.html#a426fa804e3bb58ef90b29b066c3f5199">operator=</a> (const <a class="el" href="classproton_1_1listener.html">listener</a> &)</td></tr> |
| <tr class="memdesc:a426fa804e3bb58ef90b29b066c3f5199"><td class="mdescLeft"> </td><td class="mdescRight">Copy a listener. <br /></td></tr> |
| <tr class="separator:a426fa804e3bb58ef90b29b066c3f5199"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8c528baf37154d347366083f0f816846"><td class="memItemLeft" align="right" valign="top"><a id="a8c528baf37154d347366083f0f816846"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listener.html#a8c528baf37154d347366083f0f816846">stop</a> ()</td></tr> |
| <tr class="memdesc:a8c528baf37154d347366083f0f816846"><td class="mdescLeft"> </td><td class="mdescRight">Stop listening on the address provided to the call to <a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url.">container::listen</a> that returned this listener. <br /></td></tr> |
| <tr class="separator:a8c528baf37154d347366083f0f816846"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0a3b88007d7cb5fa8d890376c5a8b102"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listener.html#a0a3b88007d7cb5fa8d890376c5a8b102">port</a> ()</td></tr> |
| <tr class="memdesc:a0a3b88007d7cb5fa8d890376c5a8b102"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettedled API</b> <a href="classproton_1_1listener.html#a0a3b88007d7cb5fa8d890376c5a8b102">More...</a><br /></td></tr> |
| <tr class="separator:a0a3b88007d7cb5fa8d890376c5a8b102"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2f632b80247e868b8264b8a025b84baf"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="classproton_1_1container.html">container</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1listener.html#a2f632b80247e868b8264b8a025b84baf">container</a> () const</td></tr> |
| <tr class="memdesc:a2f632b80247e868b8264b8a025b84baf"><td class="mdescLeft"> </td><td class="mdescRight"><b>Unsettedled API</b> <a href="classproton_1_1listener.html#a2f632b80247e868b8264b8a025b84baf">More...</a><br /></td></tr> |
| <tr class="separator:a2f632b80247e868b8264b8a025b84baf"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> |
| Friends</h2></td></tr> |
| <tr class="memitem:aa8f995c5381203abbca1b92a9a097697"><td class="memItemLeft" align="right" valign="top"><a id="aa8f995c5381203abbca1b92a9a097697"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>container</b></td></tr> |
| <tr class="separator:aa8f995c5381203abbca1b92a9a097697"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A listener for incoming connections. </p> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="broker_8cpp-example.html#_a35">broker.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#_a2">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#_a2">direct_send.cpp</a>, and <a class="el" href="server_direct_8cpp-example.html#_a2">server_direct.cpp</a>.</dd> |
| </dl> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a0a3b88007d7cb5fa8d890376c5a8b102"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0a3b88007d7cb5fa8d890376c5a8b102">◆ </a></span>port()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int port </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><b>Unsettedled API</b> </p> |
| <p>Return the port used by the listener. If port 0 was passed to <a class="el" href="classproton_1_1container.html#a9e138b28e9589583915cf5c5e0e7a524" title="Listen for new connections on listen_url.">container::listen</a>, this will be a dynamically allocated port. </p><dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="structproton_1_1error.html" title="The base Proton error.">proton::error</a></td><td>if the listener does not have a port </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="direct_recv_8cpp-example.html#a3">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#a3">direct_send.cpp</a>, and <a class="el" href="server_direct_8cpp-example.html#a3">server_direct.cpp</a>.</dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a2f632b80247e868b8264b8a025b84baf"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2f632b80247e868b8264b8a025b84baf">◆ </a></span>container()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">class <a class="el" href="classproton_1_1container.html">container</a>& <a class="el" href="classproton_1_1container.html">container</a> </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><b>Unsettedled API</b> </p> |
| <p>Get the container. </p><dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="structproton_1_1error.html" title="The base Proton error.">proton::error</a></td><td>if this listener is not managed by a container. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="listener_8hpp_source.html">listener.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceproton.html">proton</a></li><li class="navelem"><a class="el" href="classproton_1_1listener.html">listener</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> |
