blob: a168ff459b00d1d85179447e4a77064190ac0d3e [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Sep 15 14:12:07 CDT 2022 -->
<title>SocketChannelEndPoint (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.io, class: SocketChannelEndPoint">
<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/SocketChannelEndPoint.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:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.jetty.io</a></div>
<h1 title="Class SocketChannelEndPoint" class="title">Class SocketChannelEndPoint</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="IdleTimeout.html" title="class in org.eclipse.jetty.io">org.eclipse.jetty.io.IdleTimeout</a>
<div class="inheritance"><a href="AbstractEndPoint.html" title="class in org.eclipse.jetty.io">org.eclipse.jetty.io.AbstractEndPoint</a>
<div class="inheritance"><a href="SelectableChannelEndPoint.html" title="class in org.eclipse.jetty.io">org.eclipse.jetty.io.SelectableChannelEndPoint</a>
<div class="inheritance">org.eclipse.jetty.io.SocketChannelEndPoint</div>
</div>
</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="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code>, <code><a href="ManagedSelector.Selectable.html" title="interface in org.eclipse.jetty.io">ManagedSelector.Selectable</a></code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="NetworkTrafficSocketChannelEndPoint.html" title="class in org.eclipse.jetty.io">NetworkTrafficSocketChannelEndPoint</a></code>, <code><a href="../unixsocket/common/UnixSocketEndPoint.html" title="class in org.eclipse.jetty.unixsocket.common">UnixSocketEndPoint</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SocketChannelEndPoint</span>
<span class="extends-implements">extends <a href="SelectableChannelEndPoint.html" title="class in org.eclipse.jetty.io">SelectableChannelEndPoint</a></span></div>
<div class="block"><p>An <a href="EndPoint.html" title="interface in org.eclipse.jetty.io"><code>EndPoint</code></a> implementation based on <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/SocketChannel.html" title="class or interface in java.nio.channels" class="external-link"><code>SocketChannel</code></a>.</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.EndPoint">Nested classes/interfaces inherited from interface&nbsp;org.eclipse.jetty.io.<a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></h2>
<code><a href="EndPoint.Wrapper.html" title="interface in org.eclipse.jetty.io">EndPoint.Wrapper</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(java.nio.channels.SocketChannel,org.eclipse.jetty.io.ManagedSelector,java.nio.channels.SelectionKey,org.eclipse.jetty.util.thread.Scheduler)" class="member-name-link">SocketChannelEndPoint</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/SocketChannel.html" title="class or interface in java.nio.channels" class="external-link">SocketChannel</a>&nbsp;channel,
<a href="ManagedSelector.html" title="class in org.eclipse.jetty.io">ManagedSelector</a>&nbsp;selector,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/SelectionKey.html" title="class or interface in java.nio.channels" class="external-link">SelectionKey</a>&nbsp;key,
<a href="../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a>&nbsp;scheduler)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doShutdownOutput()" class="member-name-link">doShutdownOutput</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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>&nbsp;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>boolean</code></div>
<div class="col-second even-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>...&nbsp;buffers)</code></div>
<div class="col-last even-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 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/nio/channels/SocketChannel.html" title="class or interface in java.nio.channels" class="external-link">SocketChannel</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChannel()" class="member-name-link">getChannel</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.eclipse.jetty.io.SelectableChannelEndPoint">Methods inherited from class&nbsp;org.eclipse.jetty.io.<a href="SelectableChannelEndPoint.html" title="class in org.eclipse.jetty.io">SelectableChannelEndPoint</a></h3>
<code><a href="SelectableChannelEndPoint.html#doClose()">doClose</a>, <a href="SelectableChannelEndPoint.html#getLocalSocketAddress()">getLocalSocketAddress</a>, <a href="SelectableChannelEndPoint.html#getTransport()">getTransport</a>, <a href="SelectableChannelEndPoint.html#isOpen()">isOpen</a>, <a href="SelectableChannelEndPoint.html#needsFillInterest()">needsFillInterest</a>, <a href="SelectableChannelEndPoint.html#onClose(java.lang.Throwable)">onClose</a>, <a href="SelectableChannelEndPoint.html#onIncompleteFlush()">onIncompleteFlush</a>, <a href="SelectableChannelEndPoint.html#onSelected()">onSelected</a>, <a href="SelectableChannelEndPoint.html#replaceKey(java.nio.channels.SelectionKey)">replaceKey</a>, <a href="SelectableChannelEndPoint.html#toEndPointString()">toEndPointString</a>, <a href="SelectableChannelEndPoint.html#updateKey()">updateKey</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.eclipse.jetty.io.AbstractEndPoint">Methods inherited from class&nbsp;org.eclipse.jetty.io.<a href="AbstractEndPoint.html" title="class in org.eclipse.jetty.io">AbstractEndPoint</a></h3>
<code><a href="AbstractEndPoint.html#close()">close</a>, <a href="AbstractEndPoint.html#close(java.lang.Throwable)">close</a>, <a href="AbstractEndPoint.html#doShutdownInput()">doShutdownInput</a>, <a href="AbstractEndPoint.html#fillInterested(org.eclipse.jetty.util.Callback)">fillInterested</a>, <a href="AbstractEndPoint.html#getConnection()">getConnection</a>, <a href="AbstractEndPoint.html#getCreatedTimeStamp()">getCreatedTimeStamp</a>, <a href="AbstractEndPoint.html#getFillInterest()">getFillInterest</a>, <a href="AbstractEndPoint.html#getLocalAddress()">getLocalAddress</a>, <a href="AbstractEndPoint.html#getRemoteAddress()">getRemoteAddress</a>, <a href="AbstractEndPoint.html#getWriteFlusher()">getWriteFlusher</a>, <a href="AbstractEndPoint.html#isFillInterested()">isFillInterested</a>, <a href="AbstractEndPoint.html#isInputShutdown()">isInputShutdown</a>, <a href="AbstractEndPoint.html#isOutputShutdown()">isOutputShutdown</a>, <a href="AbstractEndPoint.html#onClose()">onClose</a>, <a href="AbstractEndPoint.html#onIdleExpired(java.util.concurrent.TimeoutException)">onIdleExpired</a>, <a href="AbstractEndPoint.html#onOpen()">onOpen</a>, <a href="AbstractEndPoint.html#reset()">reset</a>, <a href="AbstractEndPoint.html#setConnection(org.eclipse.jetty.io.Connection)">setConnection</a>, <a href="AbstractEndPoint.html#shutdownInput()">shutdownInput</a>, <a href="AbstractEndPoint.html#shutdownOutput()">shutdownOutput</a>, <a href="AbstractEndPoint.html#toConnectionString()">toConnectionString</a>, <a href="AbstractEndPoint.html#toString()">toString</a>, <a href="AbstractEndPoint.html#tryFillInterested(org.eclipse.jetty.util.Callback)">tryFillInterested</a>, <a href="AbstractEndPoint.html#upgrade(org.eclipse.jetty.io.Connection)">upgrade</a>, <a href="AbstractEndPoint.html#write(org.eclipse.jetty.util.Callback,java.nio.ByteBuffer...)">write</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.eclipse.jetty.io.IdleTimeout">Methods inherited from class&nbsp;org.eclipse.jetty.io.<a href="IdleTimeout.html" title="class in org.eclipse.jetty.io">IdleTimeout</a></h3>
<code><a href="IdleTimeout.html#checkIdleTimeout()">checkIdleTimeout</a>, <a href="IdleTimeout.html#getIdleFor()">getIdleFor</a>, <a href="IdleTimeout.html#getIdleTimeout()">getIdleTimeout</a>, <a href="IdleTimeout.html#getScheduler()">getScheduler</a>, <a href="IdleTimeout.html#notIdle()">notIdle</a>, <a href="IdleTimeout.html#setIdleTimeout(long)">setIdleTimeout</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#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.io.EndPoint">Methods inherited from interface&nbsp;org.eclipse.jetty.io.<a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></h3>
<code><a href="EndPoint.html#getIdleTimeout()">getIdleTimeout</a>, <a href="EndPoint.html#setIdleTimeout(long)">setIdleTimeout</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="&lt;init&gt;(java.nio.channels.SocketChannel,org.eclipse.jetty.io.ManagedSelector,java.nio.channels.SelectionKey,org.eclipse.jetty.util.thread.Scheduler)">
<h3>SocketChannelEndPoint</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SocketChannelEndPoint</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/SocketChannel.html" title="class or interface in java.nio.channels" class="external-link">SocketChannel</a>&nbsp;channel,
<a href="ManagedSelector.html" title="class in org.eclipse.jetty.io">ManagedSelector</a>&nbsp;selector,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/SelectionKey.html" title="class or interface in java.nio.channels" class="external-link">SelectionKey</a>&nbsp;key,
<a href="../util/thread/Scheduler.html" title="interface in org.eclipse.jetty.util.thread">Scheduler</a>&nbsp;scheduler)</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="getChannel()">
<h3>getChannel</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/channels/SocketChannel.html" title="class or interface in java.nio.channels" class="external-link">SocketChannel</a></span>&nbsp;<span class="element-name">getChannel</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="SelectableChannelEndPoint.html#getChannel()">getChannel</a></code>&nbsp;in class&nbsp;<code><a href="SelectableChannelEndPoint.html" title="class in org.eclipse.jetty.io">SelectableChannelEndPoint</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRemoteSocketAddress()">
<h3>getRemoteSocketAddress</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<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>&nbsp;<span class="element-name">getRemoteSocketAddress</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="EndPoint.html#getRemoteSocketAddress()">getRemoteSocketAddress</a></code>&nbsp;in interface&nbsp;<code><a href="EndPoint.html" title="interface in org.eclipse.jetty.io">EndPoint</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="AbstractEndPoint.html#getRemoteSocketAddress()">getRemoteSocketAddress</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEndPoint.html" title="class in org.eclipse.jetty.io">AbstractEndPoint</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="doShutdownOutput()">
<h3>doShutdownOutput</h3>
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">doShutdownOutput</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="AbstractEndPoint.html#doShutdownOutput()">doShutdownOutput</a></code>&nbsp;in class&nbsp;<code><a href="AbstractEndPoint.html" title="class in org.eclipse.jetty.io">AbstractEndPoint</a></code></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>&nbsp;<span class="return-type">int</span>&nbsp;<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>&nbsp;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:&nbsp;<code><a href="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>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="flush(java.nio.ByteBuffer...)">
<h3>flush</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<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>...&nbsp;buffers)</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:&nbsp;<code><a href="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>Parameters:</dt>
<dd><code>buffers</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>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>