| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 --> |
| <title>ProxyConnectionFactory.ProxyEndPoint (Eclipse Jetty API Doc - v10.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.server, class: ProxyConnectionFactory, class: ProxyEndPoint"> |
| <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/ProxyConnectionFactory.ProxyEndPoint.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><a href="#field-summary">Field</a> | </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.server</a></div> |
| <h1 title="Class ProxyConnectionFactory.ProxyEndPoint" class="title">Class ProxyConnectionFactory.ProxyEndPoint</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="../util/AttributesMap.html" title="class in org.eclipse.jetty.util">org.eclipse.jetty.util.AttributesMap</a> |
| <div class="inheritance">org.eclipse.jetty.server.ProxyConnectionFactory.ProxyEndPoint</div> |
| </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="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code>, <code><a href="../io/EndPoint.Wrapper.html" title="interface in org.eclipse.jetty.io">EndPoint.Wrapper</a></code>, <code><a href="../util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a></code>, <code><a href="../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="ProxyConnectionFactory.html" title="class in org.eclipse.jetty.server">ProxyConnectionFactory</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">ProxyConnectionFactory.ProxyEndPoint</span> |
| <span class="extends-implements">extends <a href="../util/AttributesMap.html" title="class in org.eclipse.jetty.util">AttributesMap</a> |
| implements <a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a>, <a href="../io/EndPoint.Wrapper.html" title="interface in org.eclipse.jetty.io">EndPoint.Wrapper</a></span></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.util.Attributes">Nested classes/interfaces inherited from interface org.eclipse.jetty.util.<a href="../util/Attributes.html" title="interface in org.eclipse.jetty.util">Attributes</a></h2> |
| <code><a href="../util/Attributes.Wrapper.html" title="class in org.eclipse.jetty.util">Attributes.Wrapper</a></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.<a href="../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h2> |
| <code><a href="../util/component/Dumpable.DumpableContainer.html" title="interface in org.eclipse.jetty.util.component">Dumpable.DumpableContainer</a></code></div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.eclipse.jetty.io.EndPoint">Nested classes/interfaces inherited from interface org.eclipse.jetty.io.<a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></h2> |
| <code><a href="../io/EndPoint.Wrapper.html" title="interface in org.eclipse.jetty.io">EndPoint.Wrapper</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">Fields inherited from interface org.eclipse.jetty.util.component.<a href="../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../util/component/Dumpable.html#KEY">KEY</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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.eclipse.jetty.io.EndPoint,java.net.InetSocketAddress,java.net.InetSocketAddress)" class="member-name-link">ProxyEndPoint</a><wbr>(<a href="../io/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/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> remote, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> local)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.eclipse.jetty.io.EndPoint,java.net.SocketAddress,java.net.SocketAddress)" class="member-name-link">ProxyEndPoint</a><wbr>(<a href="../io/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/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a> local, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a> remote)</code></div> |
| <div class="col-last odd-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-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="#close(java.lang.Throwable)" class="member-name-link">close</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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Close any backing stream associated with the endpoint, passing a cause</div> |
| </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="#fill(java.nio.ByteBuffer)" class="member-name-link">fill</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Fill the passed buffer with data from this endpoint.</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="#fillInterested(org.eclipse.jetty.util.Callback)" class="member-name-link">fillInterested</a><wbr>(<a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Requests callback methods to be invoked when a call to <a href="../io/EndPoint.html#fill(java.nio.ByteBuffer)"><code>EndPoint.fill(ByteBuffer)</code></a> would return data or EOF.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#flush(java.nio.ByteBuffer...)" class="member-name-link">flush</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a>... buffer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Flush data from the passed header/buffer to this endpoint.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConnection()" class="member-name-link">getConnection</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="#getCreatedTimeStamp()" class="member-name-link">getCreatedTimeStamp</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="#getIdleTimeout()" class="member-name-link">getIdleTimeout</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the max idle time in ms.</div> |
| </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/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocalAddress()" class="member-name-link">getLocalAddress</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><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocalSocketAddress()" class="member-name-link">getLocalSocketAddress</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="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRemoteAddress()" class="member-name-link">getRemoteAddress</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><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRemoteSocketAddress()" class="member-name-link">getRemoteSocketAddress</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>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTLV(int)" class="member-name-link">getTLV</a><wbr>(int type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets a TLV vector, see section 2.2.7 of the PROXY protocol specification.</div> |
| </div> |
| <div class="col-first even-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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTransport()" class="member-name-link">getTransport</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>boolean</code></div> |
| <div class="col-second odd-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 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="#isInputShutdown()" class="member-name-link">isInputShutdown</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Test if the input is shutdown.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isOpen()" class="member-name-link">isOpen</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="#isOutputShutdown()" class="member-name-link">isOutputShutdown</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Test if output is shutdown.</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="#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 <a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io"><code>EndPoint</code></a> is closed.</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="#onOpen()" class="member-name-link">onOpen</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 when this EndPoint is opened.</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="#setConnection(org.eclipse.jetty.io.Connection)" class="member-name-link">setConnection</a><wbr>(<a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a> connection)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setIdleTimeout(long)" class="member-name-link">setIdleTimeout</a><wbr>(long idleTimeout)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the idle 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="#shutdownOutput()" class="member-name-link">shutdownOutput</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Shutdown the output.</div> |
| </div> |
| <div class="col-first even-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 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>boolean</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 class="block">Requests callback methods to be invoked when a call to <a href="../io/EndPoint.html#fill(java.nio.ByteBuffer)"><code>EndPoint.fill(ByteBuffer)</code></a> would return data or EOF.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#unwrap()" class="member-name-link">unwrap</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="#upgrade(org.eclipse.jetty.io.Connection)" class="member-name-link">upgrade</a><wbr>(<a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a> newConnection)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Upgrades this EndPoint from the current connection to the given new connection.</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="#write(org.eclipse.jetty.util.Callback,java.nio.ByteBuffer...)" class="member-name-link">write</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/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a>... buffers)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Writes the given buffers via <a href="../io/EndPoint.html#flush(java.nio.ByteBuffer...)"><code>EndPoint.flush(ByteBuffer...)</code></a> and invokes callback methods when either |
| all the data has been flushed or an error occurs.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.AttributesMap">Methods inherited from class org.eclipse.jetty.util.<a href="../util/AttributesMap.html" title="class in org.eclipse.jetty.util">AttributesMap</a></h3> |
| <code><a href="../util/AttributesMap.html#addAll(org.eclipse.jetty.util.Attributes)">addAll</a>, <a href="../util/AttributesMap.html#clearAttributes()">clearAttributes</a>, <a href="../util/AttributesMap.html#dump()">dump</a>, <a href="../util/AttributesMap.html#dump(java.lang.Appendable,java.lang.String)">dump</a>, <a href="../util/AttributesMap.html#getAttribute(java.lang.String)">getAttribute</a>, <a href="../util/AttributesMap.html#getAttributeEntrySet()">getAttributeEntrySet</a>, <a href="../util/AttributesMap.html#getAttributeNames()">getAttributeNames</a>, <a href="../util/AttributesMap.html#getAttributeNamesCopy(org.eclipse.jetty.util.Attributes)">getAttributeNamesCopy</a>, <a href="../util/AttributesMap.html#getAttributeNameSet()">getAttributeNameSet</a>, <a href="../util/AttributesMap.html#removeAttribute(java.lang.String)">removeAttribute</a>, <a href="../util/AttributesMap.html#setAttribute(java.lang.String,java.lang.Object)">setAttribute</a>, <a href="../util/AttributesMap.html#size()">size</a></code></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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.util.component.Dumpable">Methods inherited from interface org.eclipse.jetty.util.component.<a href="../util/component/Dumpable.html" title="interface in org.eclipse.jetty.util.component">Dumpable</a></h3> |
| <code><a href="../util/component/Dumpable.html#dumpSelf()">dumpSelf</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.eclipse.jetty.io.EndPoint">Methods inherited from interface org.eclipse.jetty.io.<a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></h3> |
| <code><a href="../io/EndPoint.html#close()">close</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.net.InetSocketAddress,java.net.InetSocketAddress)"> |
| <h3>ProxyEndPoint</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="element-name">ProxyEndPoint</span><wbr><span class="parameters">(<a href="../io/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/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> remote, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> local)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.eclipse.jetty.io.EndPoint,java.net.SocketAddress,java.net.SocketAddress)"> |
| <h3>ProxyEndPoint</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ProxyEndPoint</span><wbr><span class="parameters">(<a href="../io/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/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a> local, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a> remote)</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="unwrap()"> |
| <h3>unwrap</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></span> <span class="element-name">unwrap</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.Wrapper.html#unwrap()">unwrap</a></code> in interface <code><a href="../io/EndPoint.Wrapper.html" title="interface in org.eclipse.jetty.io">EndPoint.Wrapper</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The wrapped <code>EndPoint</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTLV(int)"> |
| <h3>getTLV</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name">getTLV</span><wbr><span class="parameters">(int type)</span></div> |
| <div class="block"><p>Gets a TLV vector, see section 2.2.7 of the PROXY protocol specification.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - the TLV type</dd> |
| <dt>Returns:</dt> |
| <dd>the TLV value or null if not present.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close(java.lang.Throwable)"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">close</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="../io/EndPoint.html#close(java.lang.Throwable)">EndPoint</a></code></span></div> |
| <div class="block">Close any backing stream associated with the endpoint, passing a cause</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#close(java.lang.Throwable)">close</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>cause</code> - the reason for the close or null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fill(java.nio.ByteBuffer)"> |
| <h3>fill</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">fill</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#fill(java.nio.ByteBuffer)">EndPoint</a></code></span></div> |
| <div class="block">Fill the passed buffer with data from this endpoint. The bytes are appended to any |
| data already in the buffer by writing from the buffers limit up to it's capacity. |
| The limit is updated to include the filled bytes.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#fill(java.nio.ByteBuffer)">fill</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - The buffer to fill. The position and limit are modified during the fill. After the |
| operation, the position is unchanged and the limit is increased to reflect the new data filled.</dd> |
| <dt>Returns:</dt> |
| <dd>an <code>int</code> value indicating the number of bytes |
| filled or -1 if EOF is read or the input is shutdown.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if the endpoint is closed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fillInterested(org.eclipse.jetty.util.Callback)"> |
| <h3>fillInterested</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">fillInterested</span><wbr><span class="parameters">(<a href="../util/Callback.html" title="interface in org.eclipse.jetty.util">Callback</a> callback)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/ReadPendingException.html" title="class or interface in java.nio.channels" class="external-link">ReadPendingException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#fillInterested(org.eclipse.jetty.util.Callback)">EndPoint</a></code></span></div> |
| <div class="block"><p>Requests callback methods to be invoked when a call to <a href="../io/EndPoint.html#fill(java.nio.ByteBuffer)"><code>EndPoint.fill(ByteBuffer)</code></a> would return data or EOF.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#fillInterested(org.eclipse.jetty.util.Callback)">fillInterested</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>callback</code> - the callback to call when an error occurs or we are readable. The callback may implement the <a href="../util/thread/Invocable.html" title="interface in org.eclipse.jetty.util.thread"><code>Invocable</code></a> interface to |
| self declare its blocking status. Non-blocking callbacks may be called more efficiently without dispatch delays.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/ReadPendingException.html" title="class or interface in java.nio.channels" class="external-link">ReadPendingException</a></code> - if another read operation is concurrent.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="flush(java.nio.ByteBuffer...)"> |
| <h3>flush</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">flush</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a>... buffer)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#flush(java.nio.ByteBuffer...)">EndPoint</a></code></span></div> |
| <div class="block">Flush data from the passed header/buffer to this endpoint. As many bytes as can be consumed |
| are taken from the header/buffer position up until the buffer limit. The header/buffers position |
| is updated to indicate how many bytes have been consumed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#flush(java.nio.ByteBuffer...)">flush</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>buffer</code> - the buffers to flush</dd> |
| <dt>Returns:</dt> |
| <dd>True IFF all the buffers have been consumed and the endpoint has flushed the data to its |
| destination (ie is not buffering any data).</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - If the endpoint is closed or output is shutdown.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConnection()"> |
| <h3>getConnection</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a></span> <span class="element-name">getConnection</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#getConnection()">getConnection</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the <a href="../io/Connection.html" title="interface in org.eclipse.jetty.io"><code>Connection</code></a> associated with this EndPoint</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="../io/EndPoint.html#setConnection(org.eclipse.jetty.io.Connection)"><code>EndPoint.setConnection(Connection)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setConnection(org.eclipse.jetty.io.Connection)"> |
| <h3>setConnection</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setConnection</span><wbr><span class="parameters">(<a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a> connection)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#setConnection(org.eclipse.jetty.io.Connection)">setConnection</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>connection</code> - the <a href="../io/Connection.html" title="interface in org.eclipse.jetty.io"><code>Connection</code></a> associated with this EndPoint</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../io/EndPoint.html#getConnection()"><code>EndPoint.getConnection()</code></a></li> |
| <li><a href="../io/EndPoint.html#upgrade(org.eclipse.jetty.io.Connection)"><code>EndPoint.upgrade(Connection)</code></a></li> |
| </ul> |
| </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="../io/EndPoint.html#getCreatedTimeStamp()">getCreatedTimeStamp</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the epoch time in milliseconds when this EndPoint was created</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIdleTimeout()"> |
| <h3>getIdleTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getIdleTimeout</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#getIdleTimeout()">EndPoint</a></code></span></div> |
| <div class="block">Get the max idle time in ms. |
| <p>The max idle time is the time the endpoint can be idle before |
| extraordinary handling takes place.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#getIdleTimeout()">getIdleTimeout</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the max idle time in ms or if ms <= 0 implies an infinite timeout</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setIdleTimeout(long)"> |
| <h3>setIdleTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setIdleTimeout</span><wbr><span class="parameters">(long idleTimeout)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#setIdleTimeout(long)">EndPoint</a></code></span></div> |
| <div class="block">Set the idle timeout.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#setIdleTimeout(long)">setIdleTimeout</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>idleTimeout</code> - the idle timeout in MS. Timeout <= 0 implies an infinite timeout</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLocalAddress()"> |
| <h3>getLocalAddress</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/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a></span> <span class="element-name">getLocalAddress</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#getLocalAddress()">getLocalAddress</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The local InetSocketAddress to which this <code>EndPoint</code> is bound, or <code>null</code> |
| if this <code>EndPoint</code> is not bound to a Socket address.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLocalSocketAddress()"> |
| <h3>getLocalSocketAddress</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/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a></span> <span class="element-name">getLocalSocketAddress</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#getLocalSocketAddress()">getLocalSocketAddress</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the local SocketAddress to which this <code>EndPoint</code> is bound or <code>null</code> |
| if this <code>EndPoint</code> is not bound to a Socket address.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteAddress()"> |
| <h3>getRemoteAddress</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/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a></span> <span class="element-name">getRemoteAddress</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#getRemoteAddress()">getRemoteAddress</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The remote InetSocketAddress to which this <code>EndPoint</code> is connected, or <code>null</code> |
| if this <code>EndPoint</code> is not connected to a Socket address.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteSocketAddress()"> |
| <h3>getRemoteSocketAddress</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/net/SocketAddress.html" title="class or interface in java.net" class="external-link">SocketAddress</a></span> <span class="element-name">getRemoteSocketAddress</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#getRemoteSocketAddress()">getRemoteSocketAddress</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The remote SocketAddress to which this <code>EndPoint</code> is connected, or <code>null</code> |
| if this <code>EndPoint</code> is not connected to a Socket address.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTransport()"> |
| <h3>getTransport</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/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getTransport</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#getTransport()">getTransport</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The underlying transport object (socket, channel, etc.)</dd> |
| </dl> |
| </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> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#isFillInterested()">isFillInterested</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether <a href="../io/EndPoint.html#fillInterested(org.eclipse.jetty.util.Callback)"><code>EndPoint.fillInterested(Callback)</code></a> has been called, but <a href="../io/EndPoint.html#fill(java.nio.ByteBuffer)"><code>EndPoint.fill(ByteBuffer)</code></a> has not yet |
| been called</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isInputShutdown()"> |
| <h3>isInputShutdown</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isInputShutdown</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#isInputShutdown()">EndPoint</a></code></span></div> |
| <div class="block">Test if the input is shutdown. |
| The input is shutdown if an EOF has been read while doing |
| a <a href="../io/EndPoint.html#fill(java.nio.ByteBuffer)"><code>EndPoint.fill(ByteBuffer)</code></a>. Once the input is shutdown, all calls to |
| <a href="../io/EndPoint.html#fill(java.nio.ByteBuffer)"><code>EndPoint.fill(ByteBuffer)</code></a> will return -1, until such time as the |
| end point is close, when they will return <a href="../io/EofException.html" title="class in org.eclipse.jetty.io"><code>EofException</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#isInputShutdown()">isInputShutdown</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>True if the input is shutdown or the endpoint is closed.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOpen()"> |
| <h3>isOpen</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isOpen</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#isOpen()">isOpen</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>whether this EndPoint is open</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOutputShutdown()"> |
| <h3>isOutputShutdown</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isOutputShutdown</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#isOutputShutdown()">EndPoint</a></code></span></div> |
| <div class="block">Test if output is shutdown. |
| The output is shutdown by a call to <a href="../io/EndPoint.html#shutdownOutput()"><code>EndPoint.shutdownOutput()</code></a> |
| or <a href="../io/EndPoint.html#close()"><code>EndPoint.close()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#isOutputShutdown()">isOutputShutdown</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the output is shutdown or the endpoint is closed.</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="../io/EndPoint.html#onClose(java.lang.Throwable)">EndPoint</a></code></span></div> |
| <div class="block"><p>Callback method invoked when this <a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io"><code>EndPoint</code></a> is closed.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#onClose(java.lang.Throwable)">onClose</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>cause</code> - The reason for the close, or null if a normal close.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../io/EndPoint.html#onOpen()"><code>EndPoint.onOpen()</code></a></li> |
| </ul> |
| </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="../io/EndPoint.html#onOpen()">EndPoint</a></code></span></div> |
| <div class="block"><p>Callback method invoked when this EndPoint is opened.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#onOpen()">onOpen</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../io/EndPoint.html#onClose(java.lang.Throwable)"><code>EndPoint.onClose(Throwable)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdownOutput()"> |
| <h3>shutdownOutput</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">shutdownOutput</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#shutdownOutput()">EndPoint</a></code></span></div> |
| <div class="block">Shutdown the output. |
| <p>This call indicates that no more data will be sent on this endpoint that |
| that the remote end should read an EOF once all previously sent data has been |
| consumed. Shutdown may be done either at the TCP/IP level, as a protocol exchange (Eg |
| TLS close handshake) or both. |
| <p> |
| If the endpoint has <a href="../io/EndPoint.html#isInputShutdown()"><code>EndPoint.isInputShutdown()</code></a> true, then this call has the same effect |
| as <a href="../io/EndPoint.html#close()"><code>EndPoint.close()</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#shutdownOutput()">shutdownOutput</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</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">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../util/AttributesMap.html#toString()">toString</a></code> in class <code><a href="../util/AttributesMap.html" title="class in org.eclipse.jetty.util">AttributesMap</a></code></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">boolean</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> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#tryFillInterested(org.eclipse.jetty.util.Callback)">EndPoint</a></code></span></div> |
| <div class="block"><p>Requests callback methods to be invoked when a call to <a href="../io/EndPoint.html#fill(java.nio.ByteBuffer)"><code>EndPoint.fill(ByteBuffer)</code></a> would return data or EOF.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#tryFillInterested(org.eclipse.jetty.util.Callback)">tryFillInterested</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>callback</code> - the callback to call when an error occurs or we are readable. The callback may implement the <a href="../util/thread/Invocable.html" title="interface in org.eclipse.jetty.util.thread"><code>Invocable</code></a> interface to |
| self declare its blocking status. Non-blocking callbacks may be called more efficiently without dispatch delays.</dd> |
| <dt>Returns:</dt> |
| <dd>true if set</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="upgrade(org.eclipse.jetty.io.Connection)"> |
| <h3>upgrade</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">upgrade</span><wbr><span class="parameters">(<a href="../io/Connection.html" title="interface in org.eclipse.jetty.io">Connection</a> newConnection)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#upgrade(org.eclipse.jetty.io.Connection)">EndPoint</a></code></span></div> |
| <div class="block"><p>Upgrades this EndPoint from the current connection to the given new connection.</p> |
| <p>Closes the current connection, links this EndPoint to the new connection and |
| then opens the new connection.</p> |
| <p>If the current connection is an instance of <a href="../io/Connection.UpgradeFrom.html" title="interface in org.eclipse.jetty.io"><code>Connection.UpgradeFrom</code></a> then |
| a buffer of unconsumed bytes is requested. |
| If the buffer of unconsumed bytes is non-null and non-empty, then the new |
| connection is tested: if it is an instance of <a href="../io/Connection.UpgradeTo.html" title="interface in org.eclipse.jetty.io"><code>Connection.UpgradeTo</code></a>, then |
| the unconsumed buffer is passed to the new connection; otherwise, an exception |
| is thrown since there are unconsumed bytes that cannot be consumed by the new |
| connection.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#upgrade(org.eclipse.jetty.io.Connection)">upgrade</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>newConnection</code> - the connection to upgrade to</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="write(org.eclipse.jetty.util.Callback,java.nio.ByteBuffer...)"> |
| <h3>write</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">write</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/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a>... buffers)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/WritePendingException.html" title="class or interface in java.nio.channels" class="external-link">WritePendingException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../io/EndPoint.html#write(org.eclipse.jetty.util.Callback,java.nio.ByteBuffer...)">EndPoint</a></code></span></div> |
| <div class="block"><p>Writes the given buffers via <a href="../io/EndPoint.html#flush(java.nio.ByteBuffer...)"><code>EndPoint.flush(ByteBuffer...)</code></a> and invokes callback methods when either |
| all the data has been flushed or an error occurs.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../io/EndPoint.html#write(org.eclipse.jetty.util.Callback,java.nio.ByteBuffer...)">write</a></code> in interface <code><a href="../io/EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>callback</code> - the callback to call when an error occurs or the write completed. The callback may implement the <a href="../util/thread/Invocable.html" title="interface in org.eclipse.jetty.util.thread"><code>Invocable</code></a> interface to |
| self declare its blocking status. Non-blocking callbacks may be called more efficiently without dispatch delays.</dd> |
| <dd><code>buffers</code> - one or more <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link"><code>ByteBuffer</code></a>s that will be flushed.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/WritePendingException.html" title="class or interface in java.nio.channels" class="external-link">WritePendingException</a></code> - if another write operation is concurrent.</dd> |
| </dl> |
| </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> |
