blob: fdaca7dc5f7066c8134c99e7de964f275405c54f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ProtonJConnection (Qpid Proton-J API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ProtonJConnection (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/ProtonJEndpoint.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/engine/ProtonJConnection.html" target="_top">Frames</a></li>
<li><a href="ProtonJConnection.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.qpid.proton.engine</div>
<h2 title="Interface ProtonJConnection" class="title">Interface ProtonJConnection</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Connection.html" title="interface in org.apache.qpid.proton.engine">Connection</a>, <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine">Endpoint</a>, <a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a>, <a href="../../../../../org/apache/qpid/proton/engine/ProtonJEndpoint.html" title="interface in org.apache.qpid.proton.engine">ProtonJEndpoint</a>, <a href="../../../../../org/apache/qpid/proton/reactor/ReactorChild.html" title="interface in org.apache.qpid.proton.reactor">ReactorChild</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/impl/ConnectionImpl.html" title="class in org.apache.qpid.proton.engine.impl">ConnectionImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ProtonJConnection</span>
extends <a href="../../../../../org/apache/qpid/proton/engine/Connection.html" title="interface in org.apache.qpid.proton.engine">Connection</a>, <a href="../../../../../org/apache/qpid/proton/engine/ProtonJEndpoint.html" title="interface in org.apache.qpid.proton.engine">ProtonJEndpoint</a></pre>
<div class="block">Extends <a href="../../../../../org/apache/qpid/proton/engine/Connection.html" title="interface in org.apache.qpid.proton.engine"><code>Connection</code></a> with functionality that is specific to proton-j</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.qpid.proton.engine.Connection">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../org/apache/qpid/proton/engine/Connection.html" title="interface in org.apache.qpid.proton.engine">Connection</a></h3>
<code><a href="../../../../../org/apache/qpid/proton/engine/Connection.Factory.html" title="class in org.apache.qpid.proton.engine">Connection.Factory</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/ProtonJConnection.html#getMaxChannels--">getMaxChannels</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/ProtonJSession.html" title="interface in org.apache.qpid.proton.engine">ProtonJSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/ProtonJConnection.html#session--">session</a></span>()</code>
<div class="block">Returns a newly created session
TODO does the Connection's channel-max property limit how many sessions can be created,
or opened, or neither?</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/ProtonJConnection.html#setLocalContainerId-java.lang.String-">setLocalContainerId</a></span>(java.lang.String&nbsp;localContainerId)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Connection">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../org/apache/qpid/proton/engine/Connection.html" title="interface in org.apache.qpid.proton.engine">Connection</a></h3>
<code><a href="../../../../../org/apache/qpid/proton/engine/Connection.html#collect-org.apache.qpid.proton.engine.Collector-">collect</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getContainer--">getContainer</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getContext--">getContext</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getHostname--">getHostname</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getReactor--">getReactor</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getRemoteContainer--">getRemoteContainer</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getRemoteDesiredCapabilities--">getRemoteDesiredCapabilities</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getRemoteHostname--">getRemoteHostname</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getRemoteOfferedCapabilities--">getRemoteOfferedCapabilities</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getRemoteProperties--">getRemoteProperties</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getTransport--">getTransport</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getWorkHead--">getWorkHead</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#linkHead-java.util.EnumSet-java.util.EnumSet-">linkHead</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#sessionHead-java.util.EnumSet-java.util.EnumSet-">sessionHead</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#setContainer-java.lang.String-">setContainer</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#setContext-java.lang.Object-">setContext</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#setDesiredCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">setDesiredCapabilities</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#setHostname-java.lang.String-">setHostname</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#setOfferedCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">setOfferedCapabilities</a>, <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#setProperties-java.util.Map-">setProperties</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.reactor.ReactorChild">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.reactor.<a href="../../../../../org/apache/qpid/proton/reactor/ReactorChild.html" title="interface in org.apache.qpid.proton.reactor">ReactorChild</a></h3>
<code><a href="../../../../../org/apache/qpid/proton/reactor/ReactorChild.html#free--">free</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Endpoint">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine">Endpoint</a></h3>
<code><a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#close--">close</a>, <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#free--">free</a>, <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#getCondition--">getCondition</a>, <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#getLocalState--">getLocalState</a>, <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#getRemoteCondition--">getRemoteCondition</a>, <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#getRemoteState--">getRemoteState</a>, <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#open--">open</a>, <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#setCondition-org.apache.qpid.proton.amqp.transport.ErrorCondition-">setCondition</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.qpid.proton.engine.Extendable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.qpid.proton.engine.<a href="../../../../../org/apache/qpid/proton/engine/Extendable.html" title="interface in org.apache.qpid.proton.engine">Extendable</a></h3>
<code><a href="../../../../../org/apache/qpid/proton/engine/Extendable.html#attachments--">attachments</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setLocalContainerId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocalContainerId</h4>
<pre>void&nbsp;setLocalContainerId(java.lang.String&nbsp;localContainerId)</pre>
</li>
</ul>
<a name="session--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>session</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/ProtonJSession.html" title="interface in org.apache.qpid.proton.engine">ProtonJSession</a>&nbsp;session()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/qpid/proton/engine/Connection.html#session--">Connection</a></code></span></div>
<div class="block">Returns a newly created session
TODO does the Connection's channel-max property limit how many sessions can be created,
or opened, or neither?</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/qpid/proton/engine/Connection.html#session--">session</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/qpid/proton/engine/Connection.html" title="interface in org.apache.qpid.proton.engine">Connection</a></code></dd>
</dl>
</li>
</ul>
<a name="getMaxChannels--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMaxChannels</h4>
<pre>int&nbsp;getMaxChannels()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/ProtonJEndpoint.html" title="interface in org.apache.qpid.proton.engine"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/qpid/proton/engine/ProtonJConnection.html" target="_top">Frames</a></li>
<li><a href="ProtonJConnection.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>