| <!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: endpoint</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_1endpoint.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="classproton_1_1endpoint-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">endpoint<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The base class for session, connection, and link. |
| <a href="classproton_1_1endpoint.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="endpoint_8hpp_source.html">endpoint.hpp</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for endpoint:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classproton_1_1endpoint.png" usemap="#endpoint_map" alt=""/> |
| <map id="endpoint_map" name="endpoint_map"> |
| <area href="classproton_1_1connection.html" title="A connection to a remote AMQP peer." alt="connection" shape="rect" coords="0,56,74,80"/> |
| <area href="classproton_1_1link.html" title="A named channel for sending or receiving messages." alt="link" shape="rect" coords="84,56,158,80"/> |
| <area href="classproton_1_1session.html" title="A container of senders and receivers." alt="session" shape="rect" coords="168,56,242,80"/> |
| <area href="classproton_1_1receiver.html" title="A channel for receiving messages." alt="receiver" shape="rect" coords="42,112,116,136"/> |
| <area href="classproton_1_1sender.html" title="A channel for sending messages." alt="sender" shape="rect" coords="126,112,200,136"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:ad8685241f060e866802c2e806135949e"><td class="memItemLeft" align="right" valign="top"><a id="ad8685241f060e866802c2e806135949e"></a> |
| virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#ad8685241f060e866802c2e806135949e">uninitialized</a> () const =0</td></tr> |
| <tr class="memdesc:ad8685241f060e866802c2e806135949e"><td class="mdescLeft"> </td><td class="mdescRight">True if the local end is uninitialized. <br /></td></tr> |
| <tr class="separator:ad8685241f060e866802c2e806135949e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a63fb7653fe206c5e9adef8f7ad6b4d7a"><td class="memItemLeft" align="right" valign="top"><a id="a63fb7653fe206c5e9adef8f7ad6b4d7a"></a> |
| virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#a63fb7653fe206c5e9adef8f7ad6b4d7a">active</a> () const =0</td></tr> |
| <tr class="memdesc:a63fb7653fe206c5e9adef8f7ad6b4d7a"><td class="mdescLeft"> </td><td class="mdescRight">True if the local end is active. <br /></td></tr> |
| <tr class="separator:a63fb7653fe206c5e9adef8f7ad6b4d7a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a13ef393e64458da714691f90545824e9"><td class="memItemLeft" align="right" valign="top"><a id="a13ef393e64458da714691f90545824e9"></a> |
| virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#a13ef393e64458da714691f90545824e9">closed</a> () const =0</td></tr> |
| <tr class="memdesc:a13ef393e64458da714691f90545824e9"><td class="mdescLeft"> </td><td class="mdescRight">True if the local and remote ends are closed. <br /></td></tr> |
| <tr class="separator:a13ef393e64458da714691f90545824e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a89e8462fcb53c5138e0b576122d07b32"><td class="memItemLeft" align="right" valign="top"><a id="a89e8462fcb53c5138e0b576122d07b32"></a> |
| virtual class <a class="el" href="classproton_1_1error__condition.html">error_condition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#a89e8462fcb53c5138e0b576122d07b32">error</a> () const =0</td></tr> |
| <tr class="memdesc:a89e8462fcb53c5138e0b576122d07b32"><td class="mdescLeft"> </td><td class="mdescRight">Get the error condition of the remote endpoint. <br /></td></tr> |
| <tr class="separator:a89e8462fcb53c5138e0b576122d07b32"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af6ee7eacbde6b379b68d954e44f6e549"><td class="memItemLeft" align="right" valign="top"><a id="af6ee7eacbde6b379b68d954e44f6e549"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#af6ee7eacbde6b379b68d954e44f6e549">close</a> ()=0</td></tr> |
| <tr class="memdesc:af6ee7eacbde6b379b68d954e44f6e549"><td class="mdescLeft"> </td><td class="mdescRight">Close the endpoint. <br /></td></tr> |
| <tr class="separator:af6ee7eacbde6b379b68d954e44f6e549"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad4fcddcba5b74ba7766ac6f125469644"><td class="memItemLeft" align="right" valign="top"><a id="ad4fcddcba5b74ba7766ac6f125469644"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1endpoint.html#ad4fcddcba5b74ba7766ac6f125469644">close</a> (const <a class="el" href="classproton_1_1error__condition.html">error_condition</a> &)=0</td></tr> |
| <tr class="memdesc:ad4fcddcba5b74ba7766ac6f125469644"><td class="mdescLeft"> </td><td class="mdescRight">Close the endpoint with an error condition. <br /></td></tr> |
| <tr class="separator:ad4fcddcba5b74ba7766ac6f125469644"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The base class for session, connection, and link. </p> |
| </div><hr/>The documentation for this class was generated from the following file:<ul> |
| <li>proton/<a class="el" href="endpoint_8hpp_source.html">endpoint.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_1endpoint.html">endpoint</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> |
