blob: 27272cec2f14392adab1e309c39f7d6d27d75e88 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ClientSenderLinkType (Qpid ProtonJ2 Parent 1.0.0-M18 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.qpid.protonj2.client.impl, class: ClientSenderLinkType">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/ClientSenderLinkType.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.qpid.protonj2.client.impl</a></div>
<h1 title="Class ClientSenderLinkType" class="title">Class ClientSenderLinkType&lt;LinkType extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.client">Link</a>&lt;LinkType&gt;&gt;</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">org.apache.qpid.protonj2.client.impl.ClientLinkType</a>&lt;LinkType,<wbr><a href="../../engine/Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a>&gt;
<div class="inheritance">org.apache.qpid.protonj2.client.impl.ClientSenderLinkType&lt;LinkType&gt;</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Type Parameters:</dt>
<dd><code>LinkType</code> - The client sender link type being implemented.</dd>
</dl>
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../Link.html" title="interface in org.apache.qpid.protonj2.client">Link</a>&lt;LinkType&gt;</code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="ClientSender.html" title="class in org.apache.qpid.protonj2.client.impl">ClientSender</a></code>, <code><a href="ClientStreamSender.html" title="class in org.apache.qpid.protonj2.client.impl">ClientStreamSender</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ClientSenderLinkType&lt;LinkType extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.client">Link</a>&lt;LinkType&gt;&gt;</span>
<span class="extends-implements">extends <a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientLinkType</a>&lt;LinkType,<wbr><a href="../../engine/Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a>&gt;</span></div>
<div class="block">Base type for all the proton client sender types which provides a few extra
APIs for the connection and session to use when managing senders.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected <a href="../../engine/Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a></code></div>
<div class="col-second even-row-color"><code><a href="#protonSender" class="member-name-link">protonSender</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.qpid.protonj2.client.impl.ClientLinkType">Fields inherited from class&nbsp;org.apache.qpid.protonj2.client.impl.<a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientLinkType</a></h3>
<code><a href="ClientLinkType.html#closed">closed</a>, <a href="ClientLinkType.html#CLOSED_UPDATER">CLOSED_UPDATER</a>, <a href="ClientLinkType.html#closeFuture">closeFuture</a>, <a href="ClientLinkType.html#executor">executor</a>, <a href="ClientLinkType.html#failureCause">failureCause</a>, <a href="ClientLinkType.html#linkId">linkId</a>, <a href="ClientLinkType.html#linkRemotelyClosedHandler">linkRemotelyClosedHandler</a>, <a href="ClientLinkType.html#openFuture">openFuture</a>, <a href="ClientLinkType.html#options">options</a>, <a href="ClientLinkType.html#remoteSource">remoteSource</a>, <a href="ClientLinkType.html#remoteTarget">remoteTarget</a>, <a href="ClientLinkType.html#session">session</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>protected </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.qpid.protonj2.client.impl.ClientSession,java.lang.String,org.apache.qpid.protonj2.client.LinkOptions,org.apache.qpid.protonj2.engine.Sender)" class="member-name-link">ClientSenderLinkType</a><wbr>(<a href="ClientSession.html" title="class in org.apache.qpid.protonj2.client.impl">ClientSession</a>&nbsp;session,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;linkId,
<a href="../LinkOptions.html" title="class in org.apache.qpid.protonj2.client">LinkOptions</a>&lt;?&gt;&nbsp;options,
<a href="../../engine/Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a>&nbsp;protonSender)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final <a href="../../engine/Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#protonLink()" class="member-name-link">protonLink</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.qpid.protonj2.client.impl.ClientLinkType">Methods inherited from class&nbsp;org.apache.qpid.protonj2.client.impl.<a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientLinkType</a></h3>
<code><a href="ClientLinkType.html#address()">address</a>, <a href="ClientLinkType.html#checkClosedOrFailed()">checkClosedOrFailed</a>, <a href="ClientLinkType.html#client()">client</a>, <a href="ClientLinkType.html#close()">close</a>, <a href="ClientLinkType.html#close(org.apache.qpid.protonj2.client.ErrorCondition)">close</a>, <a href="ClientLinkType.html#closeAsync()">closeAsync</a>, <a href="ClientLinkType.html#closeAsync(org.apache.qpid.protonj2.client.ErrorCondition)">closeAsync</a>, <a href="ClientLinkType.html#connection()">connection</a>, <a href="ClientLinkType.html#desiredCapabilities()">desiredCapabilities</a>, <a href="ClientLinkType.html#detach()">detach</a>, <a href="ClientLinkType.html#detach(org.apache.qpid.protonj2.client.ErrorCondition)">detach</a>, <a href="ClientLinkType.html#detachAsync()">detachAsync</a>, <a href="ClientLinkType.html#detachAsync(org.apache.qpid.protonj2.client.ErrorCondition)">detachAsync</a>, <a href="ClientLinkType.html#handleEngineShutdown(org.apache.qpid.protonj2.engine.Engine)">handleEngineShutdown</a>, <a href="ClientLinkType.html#handleLocalCloseOrDetach(ProtonType)">handleLocalCloseOrDetach</a>, <a href="ClientLinkType.html#handleLocalOpen(ProtonType)">handleLocalOpen</a>, <a href="ClientLinkType.html#handleParentEndpointClosed(ProtonType)">handleParentEndpointClosed</a>, <a href="ClientLinkType.html#handleRemoteCloseOrDetach(ProtonType)">handleRemoteCloseOrDetach</a>, <a href="ClientLinkType.html#handleRemoteOpen(ProtonType)">handleRemoteOpen</a>, <a href="ClientLinkType.html#immediateLinkShutdown(org.apache.qpid.protonj2.client.exceptions.ClientException)">immediateLinkShutdown</a>, <a href="ClientLinkType.html#linkSpecificCleanupHandler(org.apache.qpid.protonj2.client.exceptions.ClientException)">linkSpecificCleanupHandler</a>, <a href="ClientLinkType.html#linkSpecificLocalCloseHandler()">linkSpecificLocalCloseHandler</a>, <a href="ClientLinkType.html#linkSpecificLocalOpenHandler()">linkSpecificLocalOpenHandler</a>, <a href="ClientLinkType.html#linkSpecificRemoteCloseHandler()">linkSpecificRemoteCloseHandler</a>, <a href="ClientLinkType.html#linkSpecificRemoteOpenHandler()">linkSpecificRemoteOpenHandler</a>, <a href="ClientLinkType.html#notClosedOrFailed(org.apache.qpid.protonj2.client.futures.ClientFuture)">notClosedOrFailed</a>, <a href="ClientLinkType.html#notClosedOrFailed(org.apache.qpid.protonj2.client.futures.ClientFuture,ProtonType)">notClosedOrFailed</a>, <a href="ClientLinkType.html#offeredCapabilities()">offeredCapabilities</a>, <a href="ClientLinkType.html#openFuture()">openFuture</a>, <a href="ClientLinkType.html#properties()">properties</a>, <a href="ClientLinkType.html#recreateLinkForReconnect()">recreateLinkForReconnect</a>, <a href="ClientLinkType.html#self()">self</a>, <a href="ClientLinkType.html#session()">session</a>, <a href="ClientLinkType.html#source()">source</a>, <a href="ClientLinkType.html#target()">target</a>, <a href="ClientLinkType.html#waitForOpenToComplete()">waitForOpenToComplete</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="protonSender">
<h3>protonSender</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../../engine/Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a></span>&nbsp;<span class="element-name">protonSender</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.qpid.protonj2.client.impl.ClientSession,java.lang.String,org.apache.qpid.protonj2.client.LinkOptions,org.apache.qpid.protonj2.engine.Sender)">
<h3>ClientSenderLinkType</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="element-name">ClientSenderLinkType</span><wbr><span class="parameters">(<a href="ClientSession.html" title="class in org.apache.qpid.protonj2.client.impl">ClientSession</a>&nbsp;session,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;linkId,
<a href="../LinkOptions.html" title="class in org.apache.qpid.protonj2.client">LinkOptions</a>&lt;?&gt;&nbsp;options,
<a href="../../engine/Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a>&nbsp;protonSender)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="protonLink()">
<h3>protonLink</h3>
<div class="member-signature"><span class="modifiers">protected final</span>&nbsp;<span class="return-type"><a href="../../engine/Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a></span>&nbsp;<span class="element-name">protonLink</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="ClientLinkType.html#protonLink()">protonLink</a></code>&nbsp;in class&nbsp;<code><a href="ClientLinkType.html" title="class in org.apache.qpid.protonj2.client.impl">ClientLinkType</a>&lt;<a href="ClientSenderLinkType.html" title="type parameter in ClientSenderLinkType">LinkType</a> extends <a href="../Link.html" title="interface in org.apache.qpid.protonj2.client">Link</a>&lt;<a href="ClientSenderLinkType.html" title="type parameter in ClientSenderLinkType">LinkType</a>&gt;,<wbr><a href="../../engine/Sender.html" title="interface in org.apache.qpid.protonj2.engine">Sender</a>&gt;</code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>