Google Git
Sign in
apache / qpid-site / cec5ef152fbc98a1ce2cfe2e67b80c051056437c / . / content / releases / qpid-proton-0.25.0 / proton / cpp / api / classproton_1_1connection.html
blob: a29ccde4cf7aab6c393f417262f91fe14b66afa5 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Qpid Proton C++ API: connection</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>
<script type="text/javascript">
$(document).ready(initResizable);
</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">
$(document).ready(function() { init_search(); });
</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.25.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
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.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</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">
$(document).ready(function(){initNavTree('classproton_1_1connection.html','');});
</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> &#124;
<a href="classproton_1_1connection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">connection</div> </div>
</div><!--header-->
<div class="contents">
<p>A connection to a remote AMQP peer.
<a href="classproton_1_1connection.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="connection_8hpp_source.html">connection.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for connection:</div>
<div class="dyncontent">
<div class="center">
<img src="classproton_1_1connection.png" usemap="#connection_map" alt=""/>
<map id="connection_map" name="connection_map">
<area href="classproton_1_1endpoint.html" title="The base class for session, connection, and link. " alt="endpoint" shape="rect" coords="263,56,516,80"/>
</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:a7fa48f6882eccec91ea9c433e1ad2a57"><td class="memItemLeft" align="right" valign="top"><a id="a7fa48f6882eccec91ea9c433e1ad2a57"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a7fa48f6882eccec91ea9c433e1ad2a57">connection</a> ()</td></tr>
<tr class="memdesc:a7fa48f6882eccec91ea9c433e1ad2a57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty connection. <br /></td></tr>
<tr class="separator:a7fa48f6882eccec91ea9c433e1ad2a57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab51c3843057c4c187574e2d44839f815"><td class="memItemLeft" align="right" valign="top"><a id="ab51c3843057c4c187574e2d44839f815"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#ab51c3843057c4c187574e2d44839f815">uninitialized</a> () const</td></tr>
<tr class="memdesc:ab51c3843057c4c187574e2d44839f815"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the local end is uninitialized. <br /></td></tr>
<tr class="separator:ab51c3843057c4c187574e2d44839f815"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9735e23cb0888fb98e1c5893aecff7e"><td class="memItemLeft" align="right" valign="top"><a id="ad9735e23cb0888fb98e1c5893aecff7e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#ad9735e23cb0888fb98e1c5893aecff7e">active</a> () const</td></tr>
<tr class="memdesc:ad9735e23cb0888fb98e1c5893aecff7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the local end is active. <br /></td></tr>
<tr class="separator:ad9735e23cb0888fb98e1c5893aecff7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae54500202b0333927a28c440c85cf07e"><td class="memItemLeft" align="right" valign="top"><a id="ae54500202b0333927a28c440c85cf07e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#ae54500202b0333927a28c440c85cf07e">closed</a> () const</td></tr>
<tr class="memdesc:ae54500202b0333927a28c440c85cf07e"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the local and remote ends are closed. <br /></td></tr>
<tr class="separator:ae54500202b0333927a28c440c85cf07e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a090a10fab22d7faf0f74c8ccda0f1470"><td class="memItemLeft" align="right" valign="top"><a id="a090a10fab22d7faf0f74c8ccda0f1470"></a>
class <a class="el" href="classproton_1_1error__condition.html">error_condition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a090a10fab22d7faf0f74c8ccda0f1470">error</a> () const</td></tr>
<tr class="memdesc:a090a10fab22d7faf0f74c8ccda0f1470"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the error condition of the remote endpoint. <br /></td></tr>
<tr class="separator:a090a10fab22d7faf0f74c8ccda0f1470"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f632b80247e868b8264b8a025b84baf"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="classproton_1_1container.html">container</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a2f632b80247e868b8264b8a025b84baf">container</a> () const</td></tr>
<tr class="memdesc:a2f632b80247e868b8264b8a025b84baf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the container. <a href="#a2f632b80247e868b8264b8a025b84baf">More...</a><br /></td></tr>
<tr class="separator:a2f632b80247e868b8264b8a025b84baf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c755d6ac6385e007adb61966598ba63"><td class="memItemLeft" align="right" valign="top"><a id="a7c755d6ac6385e007adb61966598ba63"></a>
class <a class="el" href="classproton_1_1work__queue.html">work_queue</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a7c755d6ac6385e007adb61966598ba63">work_queue</a> () const</td></tr>
<tr class="memdesc:a7c755d6ac6385e007adb61966598ba63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the <a class="el" href="classproton_1_1work__queue.html" title="Unsettled API - A context for thread-safe execution of work. ">work_queue</a> for the connection. <br /></td></tr>
<tr class="separator:a7c755d6ac6385e007adb61966598ba63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a579bcab77cddadcb8ba07d2bc576c3d6"><td class="memItemLeft" align="right" valign="top"><a id="a579bcab77cddadcb8ba07d2bc576c3d6"></a>
class <a class="el" href="classproton_1_1transport.html">transport</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a579bcab77cddadcb8ba07d2bc576c3d6">transport</a> () const</td></tr>
<tr class="memdesc:a579bcab77cddadcb8ba07d2bc576c3d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the transport for the connection. <br /></td></tr>
<tr class="separator:a579bcab77cddadcb8ba07d2bc576c3d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58c45cfdcca234c692559be81f206421"><td class="memItemLeft" align="right" valign="top"><a id="a58c45cfdcca234c692559be81f206421"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a58c45cfdcca234c692559be81f206421">virtual_host</a> () const</td></tr>
<tr class="memdesc:a58c45cfdcca234c692559be81f206421"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the remote AMQP hostname attribute for the connection. <br /></td></tr>
<tr class="separator:a58c45cfdcca234c692559be81f206421"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc9e81b6e8ae83f2043ab1db57478b33"><td class="memItemLeft" align="right" valign="top"><a id="acc9e81b6e8ae83f2043ab1db57478b33"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#acc9e81b6e8ae83f2043ab1db57478b33">container_id</a> () const</td></tr>
<tr class="memdesc:acc9e81b6e8ae83f2043ab1db57478b33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the remote container ID for the connection. <br /></td></tr>
<tr class="separator:acc9e81b6e8ae83f2043ab1db57478b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9444df7d81bd265e0a8e1726fd12b058"><td class="memItemLeft" align="right" valign="top"><a id="a9444df7d81bd265e0a8e1726fd12b058"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a9444df7d81bd265e0a8e1726fd12b058">user</a> () const</td></tr>
<tr class="memdesc:a9444df7d81bd265e0a8e1726fd12b058"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return authenticated user for the connection Note: The value returned is not stable until the on_transport_open event is received. <br /></td></tr>
<tr class="separator:a9444df7d81bd265e0a8e1726fd12b058"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e8555112049fc2b4945120b3c45f8ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a9e8555112049fc2b4945120b3c45f8ab">open</a> ()</td></tr>
<tr class="memdesc:a9e8555112049fc2b4945120b3c45f8ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the connection. <a href="#a9e8555112049fc2b4945120b3c45f8ab">More...</a><br /></td></tr>
<tr class="separator:a9e8555112049fc2b4945120b3c45f8ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91b014b59b8b14d7f5a26e2e4950cc93"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a91b014b59b8b14d7f5a26e2e4950cc93">open</a> (const <a class="el" href="classproton_1_1connection__options.html">connection_options</a> &amp;)</td></tr>
<tr class="memdesc:a91b014b59b8b14d7f5a26e2e4950cc93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open the connection. <a href="#a91b014b59b8b14d7f5a26e2e4950cc93">More...</a><br /></td></tr>
<tr class="separator:a91b014b59b8b14d7f5a26e2e4950cc93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
<tr class="memdesc:a5ae591df94fc66ccb85cbb6565368bca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the endpoint. <a href="#a5ae591df94fc66ccb85cbb6565368bca">More...</a><br /></td></tr>
<tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a817883d28ce0ac8a29d917d196796f68"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a817883d28ce0ac8a29d917d196796f68">close</a> (const <a class="el" href="classproton_1_1error__condition.html">error_condition</a> &amp;)</td></tr>
<tr class="memdesc:a817883d28ce0ac8a29d917d196796f68"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the endpoint with an error condition. <a href="#a817883d28ce0ac8a29d917d196796f68">More...</a><br /></td></tr>
<tr class="separator:a817883d28ce0ac8a29d917d196796f68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a417060fdeea996b1684bd0fecc6c6420"><td class="memItemLeft" align="right" valign="top"><a id="a417060fdeea996b1684bd0fecc6c6420"></a>
<a class="el" href="classproton_1_1session.html">session</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a417060fdeea996b1684bd0fecc6c6420">open_session</a> ()</td></tr>
<tr class="memdesc:a417060fdeea996b1684bd0fecc6c6420"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a new session. <br /></td></tr>
<tr class="separator:a417060fdeea996b1684bd0fecc6c6420"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae922e54bbff7c2d27373eea9d15e3367"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1session.html">session</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#ae922e54bbff7c2d27373eea9d15e3367">open_session</a> (const <a class="el" href="classproton_1_1session__options.html">session_options</a> &amp;)</td></tr>
<tr class="memdesc:ae922e54bbff7c2d27373eea9d15e3367"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a new session. <a href="#ae922e54bbff7c2d27373eea9d15e3367">More...</a><br /></td></tr>
<tr class="separator:ae922e54bbff7c2d27373eea9d15e3367"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e37f5c26858e9fa4399acbbcdbb6462"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1session.html">session</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a0e37f5c26858e9fa4399acbbcdbb6462">default_session</a> ()</td></tr>
<tr class="memdesc:a0e37f5c26858e9fa4399acbbcdbb6462"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the default session. <a href="#a0e37f5c26858e9fa4399acbbcdbb6462">More...</a><br /></td></tr>
<tr class="separator:a0e37f5c26858e9fa4399acbbcdbb6462"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8eece4fd4b9e1a2531ca12d2ab57a32"><td class="memItemLeft" align="right" valign="top"><a id="ae8eece4fd4b9e1a2531ca12d2ab57a32"></a>
<a class="el" href="classproton_1_1sender.html">sender</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#ae8eece4fd4b9e1a2531ca12d2ab57a32">open_sender</a> (const std::string &amp;addr)</td></tr>
<tr class="memdesc:ae8eece4fd4b9e1a2531ca12d2ab57a32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a sender for <code>addr</code> on <a class="el" href="classproton_1_1connection.html#a0e37f5c26858e9fa4399acbbcdbb6462" title="Get the default session. ">default_session()</a>. <br /></td></tr>
<tr class="separator:ae8eece4fd4b9e1a2531ca12d2ab57a32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adde43cdef3b6e132d2c4318b6087519a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1sender.html">sender</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#adde43cdef3b6e132d2c4318b6087519a">open_sender</a> (const std::string &amp;addr, const <a class="el" href="classproton_1_1sender__options.html">sender_options</a> &amp;)</td></tr>
<tr class="memdesc:adde43cdef3b6e132d2c4318b6087519a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a sender for <code>addr</code> on <a class="el" href="classproton_1_1connection.html#a0e37f5c26858e9fa4399acbbcdbb6462" title="Get the default session. ">default_session()</a>. <a href="#adde43cdef3b6e132d2c4318b6087519a">More...</a><br /></td></tr>
<tr class="separator:adde43cdef3b6e132d2c4318b6087519a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad60d14592ee9d34caca4c61214ecd27"><td class="memItemLeft" align="right" valign="top"><a id="aad60d14592ee9d34caca4c61214ecd27"></a>
<a class="el" href="classproton_1_1receiver.html">receiver</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#aad60d14592ee9d34caca4c61214ecd27">open_receiver</a> (const std::string &amp;addr)</td></tr>
<tr class="memdesc:aad60d14592ee9d34caca4c61214ecd27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a receiver for <code>addr</code> on <a class="el" href="classproton_1_1connection.html#a0e37f5c26858e9fa4399acbbcdbb6462" title="Get the default session. ">default_session()</a>. <br /></td></tr>
<tr class="separator:aad60d14592ee9d34caca4c61214ecd27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac514daf6aef85ee1e68858577e014877"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classproton_1_1receiver.html">receiver</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#ac514daf6aef85ee1e68858577e014877">open_receiver</a> (const std::string &amp;addr, const <a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> &amp;)</td></tr>
<tr class="memdesc:ac514daf6aef85ee1e68858577e014877"><td class="mdescLeft">&#160;</td><td class="mdescRight">Open a receiver for <code>addr</code> on <a class="el" href="classproton_1_1connection.html#a0e37f5c26858e9fa4399acbbcdbb6462" title="Get the default session. ">default_session()</a>. <a href="#ac514daf6aef85ee1e68858577e014877">More...</a><br /></td></tr>
<tr class="separator:ac514daf6aef85ee1e68858577e014877"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7bfc8d811be7f6be17be6cf15e35b4a"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="classproton_1_1sender__options.html">sender_options</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#ae7bfc8d811be7f6be17be6cf15e35b4a">sender_options</a> () const</td></tr>
<tr class="separator:ae7bfc8d811be7f6be17be6cf15e35b4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a099ddaa3cfcd6a8ae14401bbbfb4b660"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="classproton_1_1receiver__options.html">receiver_options</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a099ddaa3cfcd6a8ae14401bbbfb4b660">receiver_options</a> () const</td></tr>
<tr class="separator:a099ddaa3cfcd6a8ae14401bbbfb4b660"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e6f7ce08bf29e67c7a9823f1ba69561"><td class="memItemLeft" align="right" valign="top"><a id="a4e6f7ce08bf29e67c7a9823f1ba69561"></a>
session_range&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a4e6f7ce08bf29e67c7a9823f1ba69561">sessions</a> () const</td></tr>
<tr class="memdesc:a4e6f7ce08bf29e67c7a9823f1ba69561"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return all sessions on this connection. <br /></td></tr>
<tr class="separator:a4e6f7ce08bf29e67c7a9823f1ba69561"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a634a0b14e10b9fc50cbb52251c2c8027"><td class="memItemLeft" align="right" valign="top"><a id="a634a0b14e10b9fc50cbb52251c2c8027"></a>
receiver_range&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a634a0b14e10b9fc50cbb52251c2c8027">receivers</a> () const</td></tr>
<tr class="memdesc:a634a0b14e10b9fc50cbb52251c2c8027"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return all receivers on this connection. <br /></td></tr>
<tr class="separator:a634a0b14e10b9fc50cbb52251c2c8027"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e6d8395032b1d590a9e1586c7de0fb5"><td class="memItemLeft" align="right" valign="top"><a id="a2e6d8395032b1d590a9e1586c7de0fb5"></a>
sender_range&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a2e6d8395032b1d590a9e1586c7de0fb5">senders</a> () const</td></tr>
<tr class="memdesc:a2e6d8395032b1d590a9e1586c7de0fb5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return all senders on this connection. <br /></td></tr>
<tr class="separator:a2e6d8395032b1d590a9e1586c7de0fb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a491981c839dbde2411267e0654d73c4f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a491981c839dbde2411267e0654d73c4f">max_frame_size</a> () const</td></tr>
<tr class="memdesc:a491981c839dbde2411267e0654d73c4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum frame size allowed by the remote peer. <a href="#a491981c839dbde2411267e0654d73c4f">More...</a><br /></td></tr>
<tr class="separator:a491981c839dbde2411267e0654d73c4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a089389fc8a798fec049618c96c53444c"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a089389fc8a798fec049618c96c53444c">max_sessions</a> () const</td></tr>
<tr class="memdesc:a089389fc8a798fec049618c96c53444c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum number of open sessions allowed by the remote peer. <a href="#a089389fc8a798fec049618c96c53444c">More...</a><br /></td></tr>
<tr class="separator:a089389fc8a798fec049618c96c53444c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c0f78485149fbed5e8755d0633d10ed"><td class="memItemLeft" align="right" valign="top"><a id="a1c0f78485149fbed5e8755d0633d10ed"></a>
std::vector&lt; <a class="el" href="classproton_1_1symbol.html">symbol</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a1c0f78485149fbed5e8755d0633d10ed">offered_capabilities</a> () const</td></tr>
<tr class="memdesc:a1c0f78485149fbed5e8755d0633d10ed"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>Unsettled API</b> - Extension capabilities offered by the remote peer. <br /></td></tr>
<tr class="separator:a1c0f78485149fbed5e8755d0633d10ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c47682917af9e9888c836bf69d3682a"><td class="memItemLeft" align="right" valign="top"><a id="a7c47682917af9e9888c836bf69d3682a"></a>
std::vector&lt; <a class="el" href="classproton_1_1symbol.html">symbol</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a7c47682917af9e9888c836bf69d3682a">desired_capabilities</a> () const</td></tr>
<tr class="memdesc:a7c47682917af9e9888c836bf69d3682a"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>Unsettled API</b> - Extension capabilities desired by the remote peer. <br /></td></tr>
<tr class="separator:a7c47682917af9e9888c836bf69d3682a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94680c89dde19dcee4c6a7c5508e9659"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a94680c89dde19dcee4c6a7c5508e9659">idle_timeout</a> () const</td></tr>
<tr class="memdesc:a94680c89dde19dcee4c6a7c5508e9659"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the idle timeout set by the remote peer. <a href="#a94680c89dde19dcee4c6a7c5508e9659">More...</a><br /></td></tr>
<tr class="separator:a94680c89dde19dcee4c6a7c5508e9659"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a473371542eaeba6f67660582fe6a6074"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classproton_1_1connection.html#a473371542eaeba6f67660582fe6a6074">wake</a> () const</td></tr>
<tr class="memdesc:a473371542eaeba6f67660582fe6a6074"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>Unsettled API</b> - Trigger an event from another thread. <a href="#a473371542eaeba6f67660582fe6a6074">More...</a><br /></td></tr>
<tr class="separator:a473371542eaeba6f67660582fe6a6074"><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>A connection to a remote AMQP peer. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="broker_8cpp-example.html#_a17">broker.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#_a5">helloworld.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#_a12">multithreaded_client.cpp</a>, <a class="el" href="server_8cpp-example.html#_a1">server.cpp</a>, and <a class="el" href="service_bus_8cpp-example.html#_a12">service_bus.cpp</a>.</dd>
</dl></div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a2f632b80247e868b8264b8a025b84baf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f632b80247e868b8264b8a025b84baf">&#9670;&nbsp;</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>&amp; <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>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 connection is not managed by a container </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9e8555112049fc2b4945120b3c45f8ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e8555112049fc2b4945120b3c45f8ab">&#9670;&nbsp;</a></span>open() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void open </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the connection. </p>
<dl class="section see"><dt>See also</dt><dd>endpoint_lifecycle </dd></dl>
</div>
</div>
<a id="a91b014b59b8b14d7f5a26e2e4950cc93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91b014b59b8b14d7f5a26e2e4950cc93">&#9670;&nbsp;</a></span>open() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void open </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classproton_1_1connection__options.html">connection_options</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open the connection. </p>
<dl class="section see"><dt>See also</dt><dd>endpoint_lifecycle </dd></dl>
</div>
</div>
<a id="a5ae591df94fc66ccb85cbb6565368bca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ae591df94fc66ccb85cbb6565368bca">&#9670;&nbsp;</a></span>close() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the endpoint. </p>
<dl class="section see"><dt>See also</dt><dd>endpoint_lifecycle </dd></dl>
<p>Implements <a class="el" href="classproton_1_1endpoint.html#af6ee7eacbde6b379b68d954e44f6e549">endpoint</a>.</p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="client_8cpp-example.html#a20">client.cpp</a>, <a class="el" href="direct_recv_8cpp-example.html#a13">direct_recv.cpp</a>, <a class="el" href="direct_send_8cpp-example.html#a14">direct_send.cpp</a>, <a class="el" href="helloworld_8cpp-example.html#a17">helloworld.cpp</a>, <a class="el" href="multithreaded_client_8cpp-example.html#a7">multithreaded_client.cpp</a>, <a class="el" href="multithreaded_client_flow_control_8cpp-example.html#a9">multithreaded_client_flow_control.cpp</a>, <a class="el" href="scheduled_send_8cpp-example.html#a14">scheduled_send.cpp</a>, <a class="el" href="scheduled_send_03_8cpp-example.html#a12">scheduled_send_03.cpp</a>, <a class="el" href="service_bus_8cpp-example.html#a25">service_bus.cpp</a>, <a class="el" href="simple_recv_8cpp-example.html#a16">simple_recv.cpp</a>, and <a class="el" href="simple_send_8cpp-example.html#a17">simple_send.cpp</a>.</dd>
</dl>
</div>
</div>
<a id="a817883d28ce0ac8a29d917d196796f68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a817883d28ce0ac8a29d917d196796f68">&#9670;&nbsp;</a></span>close() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void close </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classproton_1_1error__condition.html">error_condition</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the endpoint with an error condition. </p>
<dl class="section see"><dt>See also</dt><dd>endpoint_lifecycle </dd></dl>
<p>Implements <a class="el" href="classproton_1_1endpoint.html#ad4fcddcba5b74ba7766ac6f125469644">endpoint</a>.</p>
</div>
</div>
<a id="ae922e54bbff7c2d27373eea9d15e3367"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae922e54bbff7c2d27373eea9d15e3367">&#9670;&nbsp;</a></span>open_session()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1session.html">session</a> open_session </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classproton_1_1session__options.html">session_options</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a new session. </p>
</div>
</div>
<a id="a0e37f5c26858e9fa4399acbbcdbb6462"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e37f5c26858e9fa4399acbbcdbb6462">&#9670;&nbsp;</a></span>default_session()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1session.html">session</a> default_session </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the default session. </p>
<p>A default session is created on the first call and reused for the lifetime of the connection. </p>
</div>
</div>
<a id="adde43cdef3b6e132d2c4318b6087519a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adde43cdef3b6e132d2c4318b6087519a">&#9670;&nbsp;</a></span>open_sender()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1sender.html">sender</a> open_sender </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classproton_1_1sender__options.html">sender_options</a> &amp;&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a sender for <code>addr</code> on <a class="el" href="classproton_1_1connection.html#a0e37f5c26858e9fa4399acbbcdbb6462" title="Get the default session. ">default_session()</a>. </p>
</div>
</div>
<a id="ac514daf6aef85ee1e68858577e014877"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac514daf6aef85ee1e68858577e014877">&#9670;&nbsp;</a></span>open_receiver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classproton_1_1receiver.html">receiver</a> open_receiver </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> &amp;&#160;</td>
<td class="paramname">&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a receiver for <code>addr</code> on <a class="el" href="classproton_1_1connection.html#a0e37f5c26858e9fa4399acbbcdbb6462" title="Get the default session. ">default_session()</a>. </p>
</div>
</div>
<a id="ae7bfc8d811be7f6be17be6cf15e35b4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7bfc8d811be7f6be17be6cf15e35b4a">&#9670;&nbsp;</a></span>sender_options()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">class <a class="el" href="classproton_1_1sender__options.html">sender_options</a> <a class="el" href="classproton_1_1sender__options.html">sender_options</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1container.html#a4fb43ab767dd944cfea2cc169f112488" title="Sender options applied to senders created by this container. ">proton::container::sender_options()</a> </dd></dl>
</div>
</div>
<a id="a099ddaa3cfcd6a8ae14401bbbfb4b660"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a099ddaa3cfcd6a8ae14401bbbfb4b660">&#9670;&nbsp;</a></span>receiver_options()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">class <a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> <a class="el" href="classproton_1_1receiver__options.html">receiver_options</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1container.html#a2e01779c75286d270f579a28dae14d37" title="Receiver options applied to receivers created by this container. ">container::receiver_options()</a> </dd></dl>
</div>
</div>
<a id="a491981c839dbde2411267e0654d73c4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a491981c839dbde2411267e0654d73c4f">&#9670;&nbsp;</a></span>max_frame_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t max_frame_size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the maximum frame size allowed by the remote peer. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1connection__options.html#ad0e93961fd048b2ee5e8bdac2b041686">connection_options::max_frame_size</a> </dd></dl>
</div>
</div>
<a id="a089389fc8a798fec049618c96c53444c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a089389fc8a798fec049618c96c53444c">&#9670;&nbsp;</a></span>max_sessions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t max_sessions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the maximum number of open sessions allowed by the remote peer. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1connection__options.html#af66706fdb4a2f3f4d9943be9ee4b1347">connection_options::max_sessions</a> </dd></dl>
</div>
</div>
<a id="a94680c89dde19dcee4c6a7c5508e9659"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94680c89dde19dcee4c6a7c5508e9659">&#9670;&nbsp;</a></span>idle_timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t idle_timeout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the idle timeout set by the remote peer. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classproton_1_1connection__options.html#a7c838237bfba8a5a04c2b97e6f023448">connection_options::idle_timeout</a> </dd></dl>
</div>
</div>
<a id="a473371542eaeba6f67660582fe6a6074"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a473371542eaeba6f67660582fe6a6074">&#9670;&nbsp;</a></span>wake()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void wake </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Unsettled API</b> - Trigger an event from another thread. </p>
<p>This method can be called from any thread. The Proton library will call <code><a class="el" href="classproton_1_1messaging__handler.html#a29bfba2d26604e5d8d7f3183f1374481" title="Unsettled API - An event that can be triggered from another thread. ">messaging_handler::on_connection_wake()</a></code> as soon as possible in the correct event-handling thread.</p>
<p><b>Thread-safety</b> - This is the <em>only</em> <code><a class="el" href="classproton_1_1connection.html" title="A connection to a remote AMQP peer. ">proton::connection</a></code> function that can be called from outside the handler thread.</p>
<dl class="section note"><dt>Note</dt><dd>Spurious <code><a class="el" href="classproton_1_1messaging__handler.html#a29bfba2d26604e5d8d7f3183f1374481" title="Unsettled API - An event that can be triggered from another thread. ">messaging_handler::on_connection_wake()</a></code> calls can occur even if the application does not call <code><a class="el" href="classproton_1_1connection.html#a473371542eaeba6f67660582fe6a6074" title="Unsettled API - Trigger an event from another thread. ">wake()</a></code>.</dd>
<dd>
Multiple calls to <code><a class="el" href="classproton_1_1connection.html#a473371542eaeba6f67660582fe6a6074" title="Unsettled API - Trigger an event from another thread. ">wake()</a></code> may be coalesced into a single call to <code><a class="el" href="classproton_1_1messaging__handler.html#a29bfba2d26604e5d8d7f3183f1374481" title="Unsettled API - An event that can be triggered from another thread. ">messaging_handler::on_connection_wake()</a></code> that occurs after all of them.</dd></dl>
<p>The <code><a class="el" href="classproton_1_1work__queue.html" title="Unsettled API - A context for thread-safe execution of work. ">proton::work_queue</a></code> interface provides an easier way execute code safely in the event-handler thread. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>proton/<a class="el" href="connection_8hpp_source.html">connection.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_1connection.html">connection</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>