content/releases/qpid-protonj2-1.0.0-M9/api/org/apache/qpid/protonj2/client/Link.html - qpid-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>Link (Qpid ProtonJ2 Parent 1.0.0-M9 API)</title>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <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 ProtonJ2 Parent 1.0.0-M9 API)";
         }
     }
     catch(err) {
     }
 //-->
 var data = {"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};
 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>
 <header role="banner">
 <nav role="navigation">
 <div class="fixedNav">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a id="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/Link.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../allclasses.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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </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 id="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 </div>
 <div class="navPadding">&nbsp;</div>
 <script type="text/javascript"><!--
 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
 //-->
 </script>
 </nav>
 </header>
 <!-- ======== START OF CLASS DATA ======== -->
 <main role="main">
 <div class="header">
 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client</a></div>
 <h2 title="Interface Link" class="title">Interface Link&lt;T extends Link&lt;T&gt;&gt;</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - The actual link type that is being created (Sender or Receiver).</dd>
 </dl>
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd>
 </dl>
 <dl>
 <dt>All Known Subinterfaces:</dt>
 <dd><code><a href="Receiver.html" title="interface in org.apache.qpid.protonj2.client">Receiver</a></code>, <code><a href="Sender.html" title="interface in org.apache.qpid.protonj2.client">Sender</a></code>, <code><a href="StreamReceiver.html" title="interface in org.apache.qpid.protonj2.client">StreamReceiver</a></code>, <code><a href="StreamSender.html" title="interface in org.apache.qpid.protonj2.client">StreamSender</a></code></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="impl/ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientLinkType</a></code>, <code><a href="impl/ClientReceiver.html" title="class in org.apache.qpid.protonj2.client.impl">ClientReceiver</a></code>, <code><a href="impl/ClientReceiverLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientReceiverLinkType</a></code>, <code><a href="impl/ClientSender.html" title="class in org.apache.qpid.protonj2.client.impl">ClientSender</a></code>, <code><a href="impl/ClientSenderLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientSenderLinkType</a></code>, <code><a href="impl/ClientStreamReceiver.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamReceiver</a></code>, <code><a href="impl/ClientStreamSender.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamSender</a></code></dd>
 </dl>
 <hr>
 <pre>public interface <span class="typeNameLabel">Link&lt;T extends Link&lt;T&gt;&gt;</span>
 extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></pre>
 <div class="block">Base for all AMQP link types (Sender, Receiver etc).</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary">
 <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="colSecond" scope="col">Method</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#address()">address</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the address that the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> instance will be subscribed to.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code><a href="Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#client()">client</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close()">close</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Requests a close of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> at the remote and waits until the Link has been
  fully closed or until the configured close timeout is exceeded.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close(org.apache.qpid.protonj2.client.ErrorCondition)">close</a></span>&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
 <td class="colLast">
 <div class="block">Requests a close of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> at the remote and waits until the Link has been
  fully closed or until the configured <a href="LinkOptions.html#closeTimeout()"><code>LinkOptions.closeTimeout()</code></a> is exceeded.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeAsync()">closeAsync</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Requests a close of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link at the remote and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be
  completed once the link has been closed.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a></span>&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
 <td class="colLast">
 <div class="block">Requests a close of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link at the remote and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be
  completed once the link has been closed.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code><a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#connection()">connection</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#desiredCapabilities()">desiredCapabilities</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the desired capabilities that the remote provided upon successfully opening the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a>.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detach()">detach</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Requests a detach of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> at the remote and waits until the Link has been
  fully detached or until the configured <a href="LinkOptions.html#closeTimeout()"><code>LinkOptions.closeTimeout()</code></a> is exceeded.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detach(org.apache.qpid.protonj2.client.ErrorCondition)">detach</a></span>&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
 <td class="colLast">
 <div class="block">Requests a detach of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> at the remote and waits until the Link has been
  fully detached or until the configured <a href="LinkOptions.html#closeTimeout()"><code>LinkOptions.closeTimeout()</code></a> is exceeded.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detachAsync()">detachAsync</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Requests a detach of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link at the remote and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be
  completed once the link has been detached.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">detachAsync</a></span>&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</code></th>
 <td class="colLast">
 <div class="block">Requests a detach of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link at the remote and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be
  completed once the link has been detached.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#offeredCapabilities()">offeredCapabilities</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the offered capabilities that the remote provided upon successfully opening the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a>.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openFuture()">openFuture</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#properties()">properties</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the properties that the remote provided upon successfully opening the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a>.</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#session()">session</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code><a href="Source.html" title="interface in org.apache.qpid.protonj2.client">Source</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#source()">source</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns an immutable view of the remote <a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a> object assigned to this link.</div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <td class="colFirst"><code><a href="Target.html" title="interface in org.apache.qpid.protonj2.client">Target</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#target()">target</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns an immutable view of the remote <a href="Target.html" title="interface in org.apache.qpid.protonj2.client"><code>Target</code></a> object assigned to this sender link.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <section role="region">
 <ul class="blockList">
 <li class="blockList"><a id="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a id="openFuture()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>openFuture</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;&nbsp;openFuture()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be completed when the remote opens this <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="client()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>client</h4>
 <pre class="methodSignature"><a href="Client.html" title="interface in org.apache.qpid.protonj2.client">Client</a>&nbsp;client()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the <a href="Client.html" title="interface in org.apache.qpid.protonj2.client"><code>Client</code></a> instance that holds this session's <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="connection()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>connection</h4>
 <pre class="methodSignature"><a href="Connection.html" title="interface in org.apache.qpid.protonj2.client">Connection</a>&nbsp;connection()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the <a href="Connection.html" title="interface in org.apache.qpid.protonj2.client"><code>Connection</code></a> instance that holds this session's <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a></dd>
 </dl>
 </li>
 </ul>
 <a id="session()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>session</h4>
 <pre class="methodSignature"><a href="Session.html" title="interface in org.apache.qpid.protonj2.client">Session</a>&nbsp;session()</pre>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the <a href="Session.html" title="interface in org.apache.qpid.protonj2.client"><code>Session</code></a> that created and holds this <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="close()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>close</h4>
 <pre class="methodSignature">void&nbsp;close()</pre>
 <div class="block">Requests a close of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> at the remote and waits until the Link has been
  fully closed or until the configured close timeout is exceeded.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html?is-external=true#close()" title="class or interface in java.lang" class="externalLink">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang" class="externalLink">AutoCloseable</a></code></dd>
 </dl>
 </li>
 </ul>
 <a id="close(org.apache.qpid.protonj2.client.ErrorCondition)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>close</h4>
 <pre class="methodSignature">void&nbsp;close&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</pre>
 <div class="block">Requests a close of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> at the remote and waits until the Link has been
  fully closed or until the configured <a href="LinkOptions.html#closeTimeout()"><code>LinkOptions.closeTimeout()</code></a> is exceeded.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the close operation.</dd>
 </dl>
 </li>
 </ul>
 <a id="detach()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>detach</h4>
 <pre class="methodSignature">void&nbsp;detach()</pre>
 <div class="block">Requests a detach of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> at the remote and waits until the Link has been
  fully detached or until the configured <a href="LinkOptions.html#closeTimeout()"><code>LinkOptions.closeTimeout()</code></a> is exceeded.</div>
 </li>
 </ul>
 <a id="detach(org.apache.qpid.protonj2.client.ErrorCondition)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>detach</h4>
 <pre class="methodSignature">void&nbsp;detach&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</pre>
 <div class="block">Requests a detach of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> at the remote and waits until the Link has been
  fully detached or until the configured <a href="LinkOptions.html#closeTimeout()"><code>LinkOptions.closeTimeout()</code></a> is exceeded.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the detach operation.</dd>
 </dl>
 </li>
 </ul>
 <a id="closeAsync()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>closeAsync</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;&nbsp;closeAsync()</pre>
 <div class="block">Requests a close of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link at the remote and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be
  completed once the link has been closed.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be completed when the remote closes this <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link.</dd>
 </dl>
 </li>
 </ul>
 <a id="closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>closeAsync</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;&nbsp;closeAsync&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</pre>
 <div class="block">Requests a close of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link at the remote and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be
  completed once the link has been closed.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the close operation.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be completed when the remote closes this <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link.</dd>
 </dl>
 </li>
 </ul>
 <a id="detachAsync()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>detachAsync</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;&nbsp;detachAsync()</pre>
 <div class="block">Requests a detach of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link at the remote and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be
  completed once the link has been detached.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be completed when the remote detaches this <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link.</dd>
 </dl>
 </li>
 </ul>
 <a id="detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>detachAsync</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink">Future</a>&lt;<a href="Link.html" title="type parameter in Link">T</a>&gt;&nbsp;detachAsync&#8203;(<a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client">ErrorCondition</a>&nbsp;error)</pre>
 <div class="block">Requests a detach of the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link at the remote and returns a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be
  completed once the link has been detached.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>error</code> - The <a href="ErrorCondition.html" title="interface in org.apache.qpid.protonj2.client"><code>ErrorCondition</code></a> to transmit to the remote along with the detach operation.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Future.html?is-external=true" title="class or interface in java.util.concurrent" class="externalLink"><code>Future</code></a> that will be completed when the remote detaches this <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> link.</dd>
 </dl>
 </li>
 </ul>
 <a id="address()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>address</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;address()
         throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Returns the address that the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> instance will be subscribed to. This method can
  block based on the type of link and how it was configured.

  <ul>
   <li>
     If the link is a Sender and it was configured as an anonymous sender then this method
     returns null as the link has no address.
   </li>
   <li>
    If a link was created with the dynamic node value enabled then the method will return
    the dynamically created address once the remote has attached its end of the opened link.
    Due to the need to await the remote peer to populate the dynamic address this method will
    block until the open of the link has completed.
   </li>
   <li>
    If not a dynamic link then the address returned is the address passed to the original
    link creation method.
   </li>
  </ul></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the address that this <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> is was assigned to.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> address.</dd>
 </dl>
 </li>
 </ul>
 <a id="source()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>source</h4>
 <pre class="methodSignature"><a href="Source.html" title="interface in org.apache.qpid.protonj2.client">Source</a>&nbsp;source()
        throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Returns an immutable view of the remote <a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a> object assigned to this link.  If the attach
  has not completed yet this method will block to await the attach response which carries the remote
  <a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the remote <a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a> node configuration.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> remote <a href="Source.html" title="interface in org.apache.qpid.protonj2.client"><code>Source</code></a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="target()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>target</h4>
 <pre class="methodSignature"><a href="Target.html" title="interface in org.apache.qpid.protonj2.client">Target</a>&nbsp;target()
        throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Returns an immutable view of the remote <a href="Target.html" title="interface in org.apache.qpid.protonj2.client"><code>Target</code></a> object assigned to this sender link.  If the
  attach has not completed yet this method will block to await the attach response which carries the remote
  <a href="Target.html" title="interface in org.apache.qpid.protonj2.client"><code>Target</code></a>.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the remote <a href="Target.html" title="interface in org.apache.qpid.protonj2.client"><code>Target</code></a> node configuration.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> remote <a href="Target.html" title="interface in org.apache.qpid.protonj2.client"><code>Target</code></a>.</dd>
 </dl>
 </li>
 </ul>
 <a id="properties()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>properties</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,&#8203;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>&gt;&nbsp;properties()
                              throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Returns the properties that the remote provided upon successfully opening the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a>.  If the
  attach has not completed yet this method will block to await the attach response which carries the remote
  properties.  If the remote provides no properties this method will return null.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>any properties provided from the remote once the sender has successfully opened.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> remote properties.</dd>
 </dl>
 </li>
 </ul>
 <a id="offeredCapabilities()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>offeredCapabilities</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;offeredCapabilities()
                       throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Returns the offered capabilities that the remote provided upon successfully opening the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a>.
  If the attach has not completed yet this method will block to await the attach response which carries the
  remote offered capabilities.  If the remote provides no capabilities this method will return null.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>any capabilities provided from the remote once the sender has successfully opened.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> remote offered capabilities.</dd>
 </dl>
 </li>
 </ul>
 <a id="desiredCapabilities()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>desiredCapabilities</h4>
 <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>[]&nbsp;desiredCapabilities()
                       throws <a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></pre>
 <div class="block">Returns the desired capabilities that the remote provided upon successfully opening the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a>.
  If the attach has not completed yet this method will block to await the attach response which carries the
  remote desired capabilities.  If the remote provides no capabilities this method will return null.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>any desired capabilities provided from the remote once the sender has successfully opened.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="exceptions/ClientException.html" title="class in org.apache.qpid.protonj2.client.exceptions">ClientException</a></code> - if an error occurs while obtaining the <a href="Link.html" title="interface in org.apache.qpid.protonj2.client"><code>Link</code></a> remote desired capabilities.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </div>
 </div>
 </main>
 <!-- ========= END OF CLASS DATA ========= -->
 <footer role="contentinfo">
 <nav role="navigation">
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a id="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a id="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/Link.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../allclasses.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>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 </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 id="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </nav>
 <p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </body>
 </html>