Google Git
Sign in
apache / qpid-site / 5404ff5f26d72c4c418dd95f4ef04e1fba050c29 / . / input / releases / qpid-proton-j-0.30.0 / api / org / apache / qpid / proton / engine / Link.html
blob: 24467fa02d811951b8bf34142c86fc619f7d5a2c [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>Link (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="Link (Qpid Proton-J API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":6,"i31":6,"i32":6,"i33":6,"i34":6,"i35":6,"i36":6,"i37":38,"i38":6,"i39":6,"i40":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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/HandlerException.html" title="class in org.apache.qpid.proton.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/ProtonJConnection.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/Link.html" target="_top">Frames</a></li>
<li><a href="Link.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 Link" class="title">Interface Link</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/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></dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Receiver.html" title="interface in org.apache.qpid.proton.engine">Receiver</a>, <a href="../../../../../org/apache/qpid/proton/engine/Sender.html" title="interface in org.apache.qpid.proton.engine">Sender</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/impl/LinkImpl.html" title="class in org.apache.qpid.proton.engine.impl">LinkImpl</a>, <a href="../../../../../org/apache/qpid/proton/engine/impl/ReceiverImpl.html" title="class in org.apache.qpid.proton.engine.impl">ReceiverImpl</a>, <a href="../../../../../org/apache/qpid/proton/engine/impl/SenderImpl.html" title="class in org.apache.qpid.proton.engine.impl">SenderImpl</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Link</span>
extends <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html" title="interface in org.apache.qpid.proton.engine">Endpoint</a></pre>
<div class="block">Link
The settlement mode defaults are:
Sender settle mode - <a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html#MIXED"><code>SenderSettleMode.MIXED</code></a>.
Receiver settle mode - <a href="../../../../../org/apache/qpid/proton/amqp/transport/ReceiverSettleMode.html#FIRST"><code>ReceiverSettleMode.FIRST</code></a>
TODO describe the application's responsibility to honour settlement.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#advance--">advance</a></span>()</code>
<div class="block">Attempts to advance the current delivery.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#current--">current</a></span>()</code>
<div class="block">Returns the current delivery</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#delivery-byte:A-">delivery</a></span>(byte[]&nbsp;tag)</code>
<div class="block">Create a delivery object based on the specified tag and adds it to the
this link's delivery list and its connection work list.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#delivery-byte:A-int-int-">delivery</a></span>(byte[]&nbsp;tag,
int&nbsp;offset,
int&nbsp;length)</code>
<div class="block">Create a delivery object based on the specified tag.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#detach--">detach</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#detached--">detached</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#drained--">drained</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getCredit--">getCredit</a></span>()</code>
<div class="block">Gets the credit balance for a link.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getDesiredCapabilities--">getDesiredCapabilities</a></span>()</code>
<div class="block">Gets the local link desired capabilities.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getDrain--">getDrain</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/UnsignedLong.html" title="class in org.apache.qpid.proton.amqp">UnsignedLong</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getMaxMessageSize--">getMaxMessageSize</a></span>()</code>
<div class="block">Gets the local link max message size.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getName--">getName</a></span>()</code>
<div class="block">Returns the name of the link</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getOfferedCapabilities--">getOfferedCapabilities</a></span>()</code>
<div class="block">Gets the local link offered capabilities.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getProperties--">getProperties</a></span>()</code>
<div class="block">Gets the local link properties.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getQueued--">getQueued</a></span>()</code>
<div class="block">Gets the number of queued messages for a link.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">ReceiverSettleMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getReceiverSettleMode--">getReceiverSettleMode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteCredit--">getRemoteCredit</a></span>()</code>
<div class="block">Returns a [locally generated] view of credit at the remote peer by considering the
current link <a href="../../../../../org/apache/qpid/proton/engine/Link.html#getCredit--"><code>credit</code></a> count as well as the effect of
any locally <a href="../../../../../org/apache/qpid/proton/engine/Link.html#getQueued--"><code>queued</code></a> messages.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteDesiredCapabilities--">getRemoteDesiredCapabilities</a></span>()</code>
<div class="block">Gets the remote link desired capabilities, as conveyed from the peer via the Attach frame
when attaching the link to the session.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/UnsignedLong.html" title="class in org.apache.qpid.proton.amqp">UnsignedLong</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteMaxMessageSize--">getRemoteMaxMessageSize</a></span>()</code>
<div class="block">Gets the remote link max message size, as conveyed from the peer via the Attach frame
when attaching the link to the session.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteOfferedCapabilities--">getRemoteOfferedCapabilities</a></span>()</code>
<div class="block">Gets the remote link offered capabilities, as conveyed from the peer via the Attach frame
when attaching the link to the session.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>,java.lang.Object&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteProperties--">getRemoteProperties</a></span>()</code>
<div class="block">Gets the remote link properties, as conveyed from the peer via the Attach frame
when attaching the link to the session.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">ReceiverSettleMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteReceiverSettleMode--">getRemoteReceiverSettleMode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">SenderSettleMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteSenderSettleMode--">getRemoteSenderSettleMode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/Source.html" title="interface in org.apache.qpid.proton.amqp.transport">Source</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteSource--">getRemoteSource</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/Target.html" title="interface in org.apache.qpid.proton.amqp.transport">Target</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteTarget--">getRemoteTarget</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">SenderSettleMode</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getSenderSettleMode--">getSenderSettleMode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Session.html" title="interface in org.apache.qpid.proton.engine">Session</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getSession--">getSession</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/Source.html" title="interface in org.apache.qpid.proton.amqp.transport">Source</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getSource--">getSource</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/amqp/transport/Target.html" title="interface in org.apache.qpid.proton.amqp.transport">Target</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getTarget--">getTarget</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#getUnsettled--">getUnsettled</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#head--">head</a></span>()</code>
<div class="block">Returns the head delivery on the link.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine">Link</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#next-java.util.EnumSet-java.util.EnumSet-">next</a></span>(java.util.EnumSet&lt;<a href="../../../../../org/apache/qpid/proton/engine/EndpointState.html" title="enum in org.apache.qpid.proton.engine">EndpointState</a>&gt;&nbsp;local,
java.util.EnumSet&lt;<a href="../../../../../org/apache/qpid/proton/engine/EndpointState.html" title="enum in org.apache.qpid.proton.engine">EndpointState</a>&gt;&nbsp;remote)</code>&nbsp;</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setDesiredCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">setDesiredCapabilities</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]&nbsp;desiredCapabilities)</code>
<div class="block">Sets the local link desired capabilities, to be conveyed to the peer via the Attach frame
when attaching the link to the session.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setMaxMessageSize-org.apache.qpid.proton.amqp.UnsignedLong-">setMaxMessageSize</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/UnsignedLong.html" title="class in org.apache.qpid.proton.amqp">UnsignedLong</a>&nbsp;maxMessageSize)</code>
<div class="block">Sets the local link max message size, to be conveyed to the peer via the Attach frame
when attaching the link to the session.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setOfferedCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">setOfferedCapabilities</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]&nbsp;offeredCapabilities)</code>
<div class="block">Sets the local link offered capabilities, to be conveyed to the peer via the Attach frame
when attaching the link to the session.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setProperties-java.util.Map-">setProperties</a></span>(java.util.Map&lt;<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>,java.lang.Object&gt;&nbsp;properties)</code>
<div class="block">Sets the local link properties, to be conveyed to the peer via the Attach frame when
attaching the link to the session.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setReceiverSettleMode-org.apache.qpid.proton.amqp.transport.ReceiverSettleMode-">setReceiverSettleMode</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">ReceiverSettleMode</a>&nbsp;receiverSettleMode)</code>
<div class="block">Sets the receiver settle mode.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setRemoteSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-">setRemoteSenderSettleMode</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">SenderSettleMode</a>&nbsp;remoteSenderSettleMode)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-">setSenderSettleMode</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">SenderSettleMode</a>&nbsp;senderSettleMode)</code>
<div class="block">Sets the sender settle mode.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setSource-org.apache.qpid.proton.amqp.transport.Source-">setSource</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/transport/Source.html" title="interface in org.apache.qpid.proton.amqp.transport">Source</a>&nbsp;address)</code>
<div class="block">Sets the source for this link.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setTarget-org.apache.qpid.proton.amqp.transport.Target-">setTarget</a></span>(<a href="../../../../../org/apache/qpid/proton/amqp/transport/Target.html" title="interface in org.apache.qpid.proton.amqp.transport">Target</a>&nbsp;address)</code>
<div class="block">Expected to be used in a similar manner to <a href="../../../../../org/apache/qpid/proton/engine/Link.html#setSource-org.apache.qpid.proton.amqp.transport.Source-"><code>setSource(Source)</code></a></div>
</td>
</tr>
</table>
<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#getContext--">getContext</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>, <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#setContext-java.lang.Object-">setContext</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="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block">Returns the name of the link</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the link name</dd>
</dl>
</li>
</ul>
<a name="delivery-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delivery</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a>&nbsp;delivery(byte[]&nbsp;tag)</pre>
<div class="block">Create a delivery object based on the specified tag and adds it to the
this link's delivery list and its connection work list.
TODO to clarify - this adds the delivery to the connection list. It is not yet
clear why this is done or if it is useful for the application to be able to discover
newly created deliveries from the <a href="../../../../../org/apache/qpid/proton/engine/Connection.html#getWorkHead--"><code>Connection.getWorkHead()</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - a tag for the delivery</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new Delivery object</dd>
</dl>
</li>
</ul>
<a name="delivery-byte:A-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delivery</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a>&nbsp;delivery(byte[]&nbsp;tag,
int&nbsp;offset,
int&nbsp;length)</pre>
<div class="block">Create a delivery object based on the specified tag. This form
of the method is intended to allow the tag to be formed from a
subsequence of the byte array passed in. This might allow more
optimisation options in future but at present is not
implemented.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tag</code> - a tag for the delivery</dd>
<dd><code>offset</code> - (currently ignored and must be 0)</dd>
<dd><code>length</code> - (currently ignored and must be the length of the <code>tag</code> array</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Delivery object</dd>
</dl>
</li>
</ul>
<a name="head--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>head</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a>&nbsp;head()</pre>
<div class="block">Returns the head delivery on the link.</div>
</li>
</ul>
<a name="current--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>current</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Delivery.html" title="interface in org.apache.qpid.proton.engine">Delivery</a>&nbsp;current()</pre>
<div class="block">Returns the current delivery</div>
</li>
</ul>
<a name="advance--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>advance</h4>
<pre>boolean&nbsp;advance()</pre>
<div class="block">Attempts to advance the current delivery. Advances it to the next delivery if one exists, else null.
The behaviour of this method is different for senders and receivers.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if it can advance, false if it cannot
TODO document the meaning of the return value more fully. Currently Senderimpl only returns false if there is no current delivery</dd>
</dl>
</li>
</ul>
<a name="getSource--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSource</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/Source.html" title="interface in org.apache.qpid.proton.amqp.transport">Source</a>&nbsp;getSource()</pre>
</li>
</ul>
<a name="getTarget--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTarget</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/Target.html" title="interface in org.apache.qpid.proton.amqp.transport">Target</a>&nbsp;getTarget()</pre>
</li>
</ul>
<a name="setSource-org.apache.qpid.proton.amqp.transport.Source-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSource</h4>
<pre>void&nbsp;setSource(<a href="../../../../../org/apache/qpid/proton/amqp/transport/Source.html" title="interface in org.apache.qpid.proton.amqp.transport">Source</a>&nbsp;address)</pre>
<div class="block">Sets the source for this link.
The initiator of the link must always provide a Source.
An application responding to the creation of the link should perform an application
specific lookup on the <a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteSource--"><code>getRemoteSource()</code></a> to determine an actual Source. If it
failed to determine an actual source, it should set null, and then go on to <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#close--"><code>Endpoint.close()</code></a>
the link.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd>"AMQP Spec 1.0 section 2.6.3"</dd>
</dl>
</li>
</ul>
<a name="setTarget-org.apache.qpid.proton.amqp.transport.Target-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTarget</h4>
<pre>void&nbsp;setTarget(<a href="../../../../../org/apache/qpid/proton/amqp/transport/Target.html" title="interface in org.apache.qpid.proton.amqp.transport">Target</a>&nbsp;address)</pre>
<div class="block">Expected to be used in a similar manner to <a href="../../../../../org/apache/qpid/proton/engine/Link.html#setSource-org.apache.qpid.proton.amqp.transport.Source-"><code>setSource(Source)</code></a></div>
</li>
</ul>
<a name="getRemoteSource--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteSource</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/Source.html" title="interface in org.apache.qpid.proton.amqp.transport">Source</a>&nbsp;getRemoteSource()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setSource-org.apache.qpid.proton.amqp.transport.Source-"><code>setSource(Source)</code></a></dd>
</dl>
</li>
</ul>
<a name="getRemoteTarget--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteTarget</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/Target.html" title="interface in org.apache.qpid.proton.amqp.transport">Target</a>&nbsp;getRemoteTarget()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setTarget-org.apache.qpid.proton.amqp.transport.Target-"><code>setTarget(Target)</code></a></dd>
</dl>
</li>
</ul>
<a name="next-java.util.EnumSet-java.util.EnumSet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine">Link</a>&nbsp;next(java.util.EnumSet&lt;<a href="../../../../../org/apache/qpid/proton/engine/EndpointState.html" title="enum in org.apache.qpid.proton.engine">EndpointState</a>&gt;&nbsp;local,
java.util.EnumSet&lt;<a href="../../../../../org/apache/qpid/proton/engine/EndpointState.html" title="enum in org.apache.qpid.proton.engine">EndpointState</a>&gt;&nbsp;remote)</pre>
</li>
</ul>
<a name="getCredit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCredit</h4>
<pre>int&nbsp;getCredit()</pre>
<div class="block">Gets the credit balance for a link.
Note that a sending link may still be used to send deliveries even if
link credit is/reaches zero, however those deliveries will end up being
<a href="../../../../../org/apache/qpid/proton/engine/Link.html#getQueued--"><code>queued</code></a> by the link until enough credit is obtained
from the receiver to send them over the wire. In this case the balance
reported will go negative.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the credit balance for the link</dd>
</dl>
</li>
</ul>
<a name="getQueued--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueued</h4>
<pre>int&nbsp;getQueued()</pre>
<div class="block">Gets the number of queued messages for a link.
Links may queue deliveries for a number of reasons, for example there may be insufficient
<a href="../../../../../org/apache/qpid/proton/engine/Link.html#getCredit--"><code>credit</code></a> to send them to the receiver, they may not have yet had a chance
to be written to the wire, or the receiving application has simply not yet processed them.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the queued message count for the link</dd>
</dl>
</li>
</ul>
<a name="getUnsettled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnsettled</h4>
<pre>int&nbsp;getUnsettled()</pre>
</li>
</ul>
<a name="getSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSession</h4>
<pre><a href="../../../../../org/apache/qpid/proton/engine/Session.html" title="interface in org.apache.qpid.proton.engine">Session</a>&nbsp;getSession()</pre>
</li>
</ul>
<a name="getSenderSettleMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSenderSettleMode</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">SenderSettleMode</a>&nbsp;getSenderSettleMode()</pre>
</li>
</ul>
<a name="setSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSenderSettleMode</h4>
<pre>void&nbsp;setSenderSettleMode(<a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">SenderSettleMode</a>&nbsp;senderSettleMode)</pre>
<div class="block">Sets the sender settle mode.
Should only be called during link set-up, i.e. before calling <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#open--"><code>Endpoint.open()</code></a>.
If this endpoint is the initiator of the link, this method can be used to set a value other than
the default.
If this endpoint is not the initiator, this method should be used to set a local value. According
to the AMQP spec, the application may choose to accept the sender's suggestion
(accessed by calling <a href="../../../../../org/apache/qpid/proton/engine/Link.html#getRemoteSenderSettleMode--"><code>getRemoteSenderSettleMode()</code></a>) or choose another value. The value
has no effect on Proton, but may be useful to the application at a later point.
In order to be AMQP compliant the application is responsible for honouring the settlement mode. See <a href="../../../../../org/apache/qpid/proton/engine/Link.html" title="interface in org.apache.qpid.proton.engine"><code>Link</code></a>.</div>
</li>
</ul>
<a name="getRemoteSenderSettleMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteSenderSettleMode</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">SenderSettleMode</a>&nbsp;getRemoteSenderSettleMode()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-"><code>setSenderSettleMode(SenderSettleMode)</code></a></dd>
</dl>
</li>
</ul>
<a name="getReceiverSettleMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReceiverSettleMode</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">ReceiverSettleMode</a>&nbsp;getReceiverSettleMode()</pre>
</li>
</ul>
<a name="setReceiverSettleMode-org.apache.qpid.proton.amqp.transport.ReceiverSettleMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReceiverSettleMode</h4>
<pre>void&nbsp;setReceiverSettleMode(<a href="../../../../../org/apache/qpid/proton/amqp/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">ReceiverSettleMode</a>&nbsp;receiverSettleMode)</pre>
<div class="block">Sets the receiver settle mode.
Used in analogous way to <a href="../../../../../org/apache/qpid/proton/engine/Link.html#setSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-"><code>setSenderSettleMode(SenderSettleMode)</code></a></div>
</li>
</ul>
<a name="getRemoteReceiverSettleMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteReceiverSettleMode</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/transport/ReceiverSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">ReceiverSettleMode</a>&nbsp;getRemoteReceiverSettleMode()</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setReceiverSettleMode-org.apache.qpid.proton.amqp.transport.ReceiverSettleMode-"><code>setReceiverSettleMode(ReceiverSettleMode)</code></a></dd>
</dl>
</li>
</ul>
<a name="setRemoteSenderSettleMode-org.apache.qpid.proton.amqp.transport.SenderSettleMode-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRemoteSenderSettleMode</h4>
<pre>@Deprecated
void&nbsp;setRemoteSenderSettleMode(<a href="../../../../../org/apache/qpid/proton/amqp/transport/SenderSettleMode.html" title="enum in org.apache.qpid.proton.amqp.transport">SenderSettleMode</a>&nbsp;remoteSenderSettleMode)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">TODO should this be part of the interface?</div>
</li>
</ul>
<a name="getProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre>java.util.Map&lt;<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>,java.lang.Object&gt;&nbsp;getProperties()</pre>
<div class="block">Gets the local link properties.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setProperties-java.util.Map-"><code>setProperties(Map)</code></a></dd>
</dl>
</li>
</ul>
<a name="setProperties-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperties</h4>
<pre>void&nbsp;setProperties(java.util.Map&lt;<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>,java.lang.Object&gt;&nbsp;properties)</pre>
<div class="block">Sets the local link properties, to be conveyed to the peer via the Attach frame when
attaching the link to the session.
Must be called during link setup, i.e. before calling the <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#open--"><code>Endpoint.open()</code></a> method.</div>
</li>
</ul>
<a name="getRemoteProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteProperties</h4>
<pre>java.util.Map&lt;<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>,java.lang.Object&gt;&nbsp;getRemoteProperties()</pre>
<div class="block">Gets the remote link properties, as conveyed from the peer via the Attach frame
when attaching the link to the session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the properties Map conveyed by the peer, or null if there was none.</dd>
</dl>
</li>
</ul>
<a name="drained--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>drained</h4>
<pre>int&nbsp;drained()</pre>
</li>
</ul>
<a name="getRemoteCredit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteCredit</h4>
<pre>int&nbsp;getRemoteCredit()</pre>
<div class="block">Returns a [locally generated] view of credit at the remote peer by considering the
current link <a href="../../../../../org/apache/qpid/proton/engine/Link.html#getCredit--"><code>credit</code></a> count as well as the effect of
any locally <a href="../../../../../org/apache/qpid/proton/engine/Link.html#getQueued--"><code>queued</code></a> messages.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>view of effective remote credit</dd>
</dl>
</li>
</ul>
<a name="getDrain--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDrain</h4>
<pre>boolean&nbsp;getDrain()</pre>
</li>
</ul>
<a name="detach--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detach</h4>
<pre>void&nbsp;detach()</pre>
</li>
</ul>
<a name="detached--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>detached</h4>
<pre>boolean&nbsp;detached()</pre>
</li>
</ul>
<a name="setOfferedCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOfferedCapabilities</h4>
<pre>void&nbsp;setOfferedCapabilities(<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]&nbsp;offeredCapabilities)</pre>
<div class="block">Sets the local link offered capabilities, to be conveyed to the peer via the Attach frame
when attaching the link to the session.
Must be called during link setup, i.e. before calling the <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#open--"><code>Endpoint.open()</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>offeredCapabilities</code> - the offered capabilities array to send, or null for none.</dd>
</dl>
</li>
</ul>
<a name="getOfferedCapabilities--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOfferedCapabilities</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]&nbsp;getOfferedCapabilities()</pre>
<div class="block">Gets the local link offered capabilities.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the offered capabilities array, or null if none was set.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setOfferedCapabilities-org.apache.qpid.proton.amqp.Symbol:A-"><code>setOfferedCapabilities(Symbol[])</code></a></dd>
</dl>
</li>
</ul>
<a name="getRemoteOfferedCapabilities--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteOfferedCapabilities</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]&nbsp;getRemoteOfferedCapabilities()</pre>
<div class="block">Gets the remote link offered capabilities, as conveyed from the peer via the Attach frame
when attaching the link to the session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the offered capabilities array conveyed by the peer, or null if there was none.</dd>
</dl>
</li>
</ul>
<a name="setDesiredCapabilities-org.apache.qpid.proton.amqp.Symbol:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDesiredCapabilities</h4>
<pre>void&nbsp;setDesiredCapabilities(<a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]&nbsp;desiredCapabilities)</pre>
<div class="block">Sets the local link desired capabilities, to be conveyed to the peer via the Attach frame
when attaching the link to the session.
Must be called during link setup, i.e. before calling the <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#open--"><code>Endpoint.open()</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>desiredCapabilities</code> - the desired capabilities array to send, or null for none.</dd>
</dl>
</li>
</ul>
<a name="getDesiredCapabilities--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDesiredCapabilities</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]&nbsp;getDesiredCapabilities()</pre>
<div class="block">Gets the local link desired capabilities.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the desired capabilities array, or null if none was set.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setDesiredCapabilities-org.apache.qpid.proton.amqp.Symbol:A-"><code>setDesiredCapabilities(Symbol[])</code></a></dd>
</dl>
</li>
</ul>
<a name="getRemoteDesiredCapabilities--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRemoteDesiredCapabilities</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/Symbol.html" title="class in org.apache.qpid.proton.amqp">Symbol</a>[]&nbsp;getRemoteDesiredCapabilities()</pre>
<div class="block">Gets the remote link desired capabilities, as conveyed from the peer via the Attach frame
when attaching the link to the session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the desired capabilities array conveyed by the peer, or null if there was none.</dd>
</dl>
</li>
</ul>
<a name="setMaxMessageSize-org.apache.qpid.proton.amqp.UnsignedLong-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxMessageSize</h4>
<pre>void&nbsp;setMaxMessageSize(<a href="../../../../../org/apache/qpid/proton/amqp/UnsignedLong.html" title="class in org.apache.qpid.proton.amqp">UnsignedLong</a>&nbsp;maxMessageSize)</pre>
<div class="block">Sets the local link max message size, to be conveyed to the peer via the Attach frame
when attaching the link to the session. Null or 0 means no limit.
Must be called during link setup, i.e. before calling the <a href="../../../../../org/apache/qpid/proton/engine/Endpoint.html#open--"><code>Endpoint.open()</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxMessageSize</code> - the local max message size value, or null to clear. 0 also means no limit.</dd>
</dl>
</li>
</ul>
<a name="getMaxMessageSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxMessageSize</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/UnsignedLong.html" title="class in org.apache.qpid.proton.amqp">UnsignedLong</a>&nbsp;getMaxMessageSize()</pre>
<div class="block">Gets the local link max message size.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the local max message size, or null if none was set. 0 also means no limit.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/qpid/proton/engine/Link.html#setMaxMessageSize-org.apache.qpid.proton.amqp.UnsignedLong-"><code>setMaxMessageSize(UnsignedLong)</code></a></dd>
</dl>
</li>
</ul>
<a name="getRemoteMaxMessageSize--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRemoteMaxMessageSize</h4>
<pre><a href="../../../../../org/apache/qpid/proton/amqp/UnsignedLong.html" title="class in org.apache.qpid.proton.amqp">UnsignedLong</a>&nbsp;getRemoteMaxMessageSize()</pre>
<div class="block">Gets the remote link max message size, as conveyed from the peer via the Attach frame
when attaching the link to the session.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the remote max message size conveyed by the peer, or null if none was set. 0 also means no limit.</dd>
</dl>
</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/HandlerException.html" title="class in org.apache.qpid.proton.engine"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/qpid/proton/engine/ProtonJConnection.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/Link.html" target="_top">Frames</a></li>
<li><a href="Link.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>