| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:13:16 CDT 2022 --> |
| <title>AbstractConnection (Eclipse Jetty API Doc - v11.0.12)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-09-15"> |
| <meta name="description" content="declaration: package: org.eclipse.jetty.io, class: AbstractConnection"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.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"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</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/AbstractConnection.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="../../../../index-all.html">Index</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: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </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> <a href="package-summary.html">org.eclipse.jetty.io</a></div> |
| <h1 title="Class AbstractConnection" class="title">Class AbstractConnection</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">org.eclipse.jetty.io.AbstractConnection</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <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/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <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="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../http2/HTTP2Connection.html" title="class in org.eclipse.jetty.http2">HTTP2Connection</a></code>, <code><a href="../server/HttpConnection.html" title="class in org.eclipse.jetty.server">HttpConnection</a></code>, <code><a href="../fcgi/client/http/HttpConnectionOverFCGI.html" title="class in org.eclipse.jetty.fcgi.client.http">HttpConnectionOverFCGI</a></code>, <code><a href="../client/http/HttpConnectionOverHTTP.html" title="class in org.eclipse.jetty.client.http">HttpConnectionOverHTTP</a></code>, <code><a href="NegotiatingClientConnection.html" title="class in org.eclipse.jetty.io">NegotiatingClientConnection</a></code>, <code><a href="../server/NegotiatingServerConnection.html" title="class in org.eclipse.jetty.server">NegotiatingServerConnection</a></code>, <code><a href="../proxy/ProxyConnection.html" title="class in org.eclipse.jetty.proxy">ProxyConnection</a></code>, <code><a href="../client/ProxyProtocolClientConnectionFactory.ProxyProtocolConnection.html" title="class in org.eclipse.jetty.client">ProxyProtocolClientConnectionFactory.ProxyProtocolConnection</a></code>, <code><a href="../quic/common/QuicConnection.html" title="class in org.eclipse.jetty.quic.common">QuicConnection</a></code>, <code><a href="../fcgi/server/ServerFCGIConnection.html" title="class in org.eclipse.jetty.fcgi.server">ServerFCGIConnection</a></code>, <code><a href="ssl/SslConnection.html" title="class in org.eclipse.jetty.io.ssl">SslConnection</a></code>, <code><a href="../websocket/core/internal/WebSocketConnection.html" title="class in org.eclipse.jetty.websocket.core.internal">WebSocketConnection</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">AbstractConnection</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></span></div> |
| <div class="block"><p>A convenience base implementation of <a href="Connection.html" title="interface in org.eclipse.jetty.io"><code>Connection</code></a>.</p> |
| <p>This class uses the capabilities of the <a href="EndPoint.html" title="interface in org.eclipse.jetty.io"><code>EndPoint</code></a> API to provide a |
| more traditional style of async reading. A call to <a href="#fillInterested()"><code>fillInterested()</code></a> |
| will schedule a callback to <a href="#onFillable()"><code>onFillable()</code></a> or <a href="#onFillInterestedFailed(java.lang.Throwable)"><code>onFillInterestedFailed(Throwable)</code></a> |
| as appropriate.</p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.io.Connection">Nested classes/interfaces inherited from interface org.eclipse.jetty.io.<a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></h2> |
| <code><a href="Connection.Listener.html" title="interface in org.eclipse.jetty.io">Connection.Listener</a>, <a href="Connection.UpgradeFrom.html" title="interface in org.eclipse.jetty.io">Connection.UpgradeFrom</a>, <a href="Connection.UpgradeTo.html" title="interface in org.eclipse.jetty.io">Connection.UpgradeTo</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.eclipse.jetty.io.EndPoint,java.util.concurrent.Executor)" class="member-name-link">AbstractConnection</a><wbr>(<a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a> endPoint, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a> executor)</code></div> |
| <div class="col-last even-row-color"> </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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addEventListener(java.util.EventListener)" class="member-name-link">addEventListener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a> listener)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds a listener of connection events.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Performs a logical close of this connection.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#failedCallback(org.eclipse.jetty.util.Callback,java.lang.Throwable)" class="member-name-link">failedCallback</a><wbr>(<a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> x)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#fillInterested()" class="member-name-link">fillInterested</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Utility method to be called to register read interest.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBytesIn()" class="member-name-link">getBytesIn</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBytesOut()" class="member-name-link">getBytesOut</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCreatedTimeStamp()" class="member-name-link">getCreatedTimeStamp</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEndPoint()" class="member-name-link">getEndPoint</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getExecutor()" class="member-name-link">getExecutor</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getInputBufferSize()" class="member-name-link">getInputBufferSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMessagesIn()" class="member-name-link">getMessagesIn</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMessagesOut()" class="member-name-link">getMessagesOut</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFillInterested()" class="member-name-link">isFillInterested</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onClose(java.lang.Throwable)" class="member-name-link">onClose</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Callback method invoked when this connection is closed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#onFillable()" class="member-name-link">onFillable</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Callback method invoked when the endpoint is ready to be read.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onFillInterestedFailed(java.lang.Throwable)" class="member-name-link">onFillInterestedFailed</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Callback method invoked when the endpoint failed to be ready to be read.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onIdleExpired()" class="member-name-link">onIdleExpired</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Callback method invoked upon an idle timeout event.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onOpen()" class="member-name-link">onOpen</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Callback method invoked when this connection is opened.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onReadTimeout(java.lang.Throwable)" class="member-name-link">onReadTimeout</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> timeout)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Callback method invoked when the endpoint failed to be ready to be read after a timeout</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeEventListener(java.util.EventListener)" class="member-name-link">removeEventListener</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a> listener)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes a listener of connection events.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInputBufferSize(int)" class="member-name-link">setInputBufferSize</a><wbr>(int inputBufferSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toConnectionString()" class="member-name-link">toConnectionString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#tryFillInterested(org.eclipse.jetty.util.Callback)" class="member-name-link">tryFillInterested</a><wbr>(<a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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#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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.io.EndPoint,java.util.concurrent.Executor)"> |
| <h3>AbstractConnection</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">AbstractConnection</span><wbr><span class="parameters">(<a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a> endPoint, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a> executor)</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="addEventListener(java.util.EventListener)"> |
| <h3>addEventListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addEventListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a> listener)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Connection.html#addEventListener(java.util.EventListener)">Connection</a></code></span></div> |
| <div class="block"><p>Adds a listener of connection events.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#addEventListener(java.util.EventListener)">addEventListener</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>listener</code> - the listener to add</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeEventListener(java.util.EventListener)"> |
| <h3>removeEventListener</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">removeEventListener</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EventListener.html" title="class or interface in java.util" class="external-link">EventListener</a> listener)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Connection.html#removeEventListener(java.util.EventListener)">Connection</a></code></span></div> |
| <div class="block"><p>Removes a listener of connection events.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#removeEventListener(java.util.EventListener)">removeEventListener</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>listener</code> - the listener to remove</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInputBufferSize()"> |
| <h3>getInputBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getInputBufferSize</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setInputBufferSize(int)"> |
| <h3>setInputBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setInputBufferSize</span><wbr><span class="parameters">(int inputBufferSize)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getExecutor()"> |
| <h3>getExecutor</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a></span> <span class="element-name">getExecutor</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="failedCallback(org.eclipse.jetty.util.Callback,java.lang.Throwable)"> |
| <h3>failedCallback</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">failedCallback</span><wbr><span class="parameters">(<a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> x)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fillInterested()"> |
| <h3>fillInterested</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">fillInterested</span>()</div> |
| <div class="block"><p>Utility method to be called to register read interest.</p> |
| <p>After a call to this method, <a href="#onFillable()"><code>onFillable()</code></a> or <a href="#onFillInterestedFailed(java.lang.Throwable)"><code>onFillInterestedFailed(Throwable)</code></a> |
| will be called back as appropriate.</p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#onFillable()"><code>onFillable()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="tryFillInterested(org.eclipse.jetty.util.Callback)"> |
| <h3>tryFillInterested</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">tryFillInterested</span><wbr><span class="parameters">(<a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isFillInterested()"> |
| <h3>isFillInterested</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFillInterested</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onFillable()"> |
| <h3>onFillable</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">onFillable</span>()</div> |
| <div class="block"><p>Callback method invoked when the endpoint is ready to be read.</p></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#fillInterested()"><code>fillInterested()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onFillInterestedFailed(java.lang.Throwable)"> |
| <h3>onFillInterestedFailed</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">onFillInterestedFailed</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</span></div> |
| <div class="block"><p>Callback method invoked when the endpoint failed to be ready to be read.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>cause</code> - the exception that caused the failure</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onReadTimeout(java.lang.Throwable)"> |
| <h3>onReadTimeout</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name">onReadTimeout</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> timeout)</span></div> |
| <div class="block"><p>Callback method invoked when the endpoint failed to be ready to be read after a timeout</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>timeout</code> - the cause of the read timeout</dd> |
| <dt>Returns:</dt> |
| <dd>true to signal that the endpoint must be closed, false to keep the endpoint open</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onOpen()"> |
| <h3>onOpen</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onOpen</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Connection.html#onOpen()">Connection</a></code></span></div> |
| <div class="block"><p>Callback method invoked when this connection is opened.</p> |
| <p>Creators of the connection implementation are responsible for calling this method.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#onOpen()">onOpen</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onClose(java.lang.Throwable)"> |
| <h3>onClose</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onClose</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a> cause)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Connection.html#onClose(java.lang.Throwable)">Connection</a></code></span></div> |
| <div class="block"><p>Callback method invoked when this connection is closed.</p> |
| <p>Creators of the connection implementation are responsible for calling this method.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#onClose(java.lang.Throwable)">onClose</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>cause</code> - The cause of the close or null for a normal close</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEndPoint()"> |
| <h3>getEndPoint</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></span> <span class="element-name">getEndPoint</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#getEndPoint()">getEndPoint</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the <a href="EndPoint.html" title="interface in org.eclipse.jetty.io"><code>EndPoint</code></a> associated with this Connection.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Connection.html#close()">Connection</a></code></span></div> |
| <div class="block"><p>Performs a logical close of this connection.</p> |
| <p>For simple connections, this may just mean to delegate the close to the associated |
| <a href="EndPoint.html" title="interface in org.eclipse.jetty.io"><code>EndPoint</code></a> but, for example, SSL connections should write the SSL close message |
| before closing the associated <a href="EndPoint.html" title="interface in org.eclipse.jetty.io"><code>EndPoint</code></a>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <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></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#close()">close</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onIdleExpired()"> |
| <h3>onIdleExpired</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">onIdleExpired</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Connection.html#onIdleExpired()">Connection</a></code></span></div> |
| <div class="block"><p>Callback method invoked upon an idle timeout event.</p> |
| <p>Implementations of this method may return true to indicate that the idle timeout |
| handling should proceed normally, typically failing the EndPoint and causing it to |
| be closed.</p> |
| <p>When false is returned, the handling of the idle timeout event is halted |
| immediately and the EndPoint left in the state it was before the idle timeout event.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#onIdleExpired()">onIdleExpired</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true to let the EndPoint handle the idle timeout, |
| false to tell the EndPoint to halt the handling of the idle timeout.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMessagesIn()"> |
| <h3>getMessagesIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMessagesIn</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#getMessagesIn()">getMessagesIn</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMessagesOut()"> |
| <h3>getMessagesOut</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMessagesOut</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#getMessagesOut()">getMessagesOut</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBytesIn()"> |
| <h3>getBytesIn</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getBytesIn</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#getBytesIn()">getBytesIn</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBytesOut()"> |
| <h3>getBytesOut</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getBytesOut</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#getBytesOut()">getBytesOut</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCreatedTimeStamp()"> |
| <h3>getCreatedTimeStamp</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getCreatedTimeStamp</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Connection.html#getCreatedTimeStamp()">getCreatedTimeStamp</a></code> in interface <code><a href="Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><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></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toConnectionString()"> |
| <h3>toConnectionString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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></span> <span class="element-name">toConnectionString</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |