EE10 :: Servlet 12.0.6 · org.eclipse.jetty.ee10.servlet.HttpOutput

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static enum	HttpOutput.ApiState The API State which combines with the output State: OPEN/BLOCKING---last----------------------------+ CLOSED/BLOCKING / \| ^ \ ^ ^ / w \| \ / \| / \| owc +--owcL------------------->--owcL-----\---------------------+ \| \| v \| / / V \| swl OPEN/BLOCKED----last---->CLOSE/BLOCKED----owc----->CLOSING/BLOCKED--owcL------+ \| \ \ V +-->OPEN/READY------last---------------------------+ / ^ \| \ / / w \ \| / \| +--owcL------------------->--owcL----\---------------------------+ \| / v / / V \| \| irt OPEN/PENDING----last---->CLOSE/PENDING----owc---->CLOSING/PENDING--owcL----+ \| \| \ / \| \| ^ \| \| \| owc \/ owc irf / irf \| \| \| /\ \| \| / \| \| \| \| / \ V \| / \| V V \| irf OPEN/ASYNC------last----------\|----------------+ \| CLOSED/ASYNC \| \ \| \| ^ ^ \ \ \| \| \| \| \ \ \| \| \| \| \ v v v \| \| +--OPEN/UNREADY----last---->CLOSE/UNREADY----owc----->CLOSING/UNREADY--owcL---+ \| \ \ \| +--owcL------------------->--owcL--------------------------------+ swl : setWriteListener w : write owc : onWriteComplete last == false owcL : onWriteComplete last == true irf : isReady() == false irt : isReady() == true last : close() or complete(Callback) or write of known last content
private class	HttpOutput.AsyncFlush
private class	HttpOutput.AsyncWrite
private abstract class	HttpOutput.ChannelWriteCB
private class	HttpOutput.CompleteWriteCompleteCB
private class	HttpOutput.InputStreamWritingCB An iterating callback that will take content from an InputStream and write it to this HttpOutput.
private abstract class	HttpOutput.NestedChannelWriteCB
private class	HttpOutput.ReadableByteChannelWritingCB An iterating callback that will take content from a ReadableByteChannel and write it to this HttpOutput.
pack-priv static enum	HttpOutput.State The output state
private class	HttpOutput.WriteCompleteCB

Modifier and Type	Field and Description
private RetainableByteBuffer	_aggregate
private HttpOutput.ApiState	_apiState
private int	_bufferSize
private final ServletChannelState	_channelState
private Callback	_closedCallback
private int	_commitSize
private static final ThreadLocal<CharsetEncoder>	_encoder
private long	_firstByteNanoTime
private long	_flushed
private volatile Throwable	_onError
private final ServletChannel	_servletChannel
private boolean	_softClose
private HttpOutput.State	_state
private final Blocker.Shared	_writeBlocker
private WriteListener	_writeListener
private long	_written
private static final Logger	LOG

Access	Constructor and Description
public	HttpOutput(ServletChannel channel)

Method Summary

Modifier and Type	Method and Description
private RetainableByteBuffer	acquireBuffer()
private void	channelWrite(ByteBuffer content, boolean complete)
private void	channelWrite(ByteBuffer content, boolean last, Callback callback)
private void	checkWritable()
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
public void	complete(Callback The callback to complete when writing the output is complete. callback) This method is invoked for the COMPLETE action handling in HttpChannel.handle.
public void	completed(Throwable failure) Called to indicate that the request cycle has been completed.
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
public int	getBufferSize()
public ByteBuffer	getByteBuffer()
public long	Returns: The bytes written via the `jakarta.servlet.http.HttpServletResponse` API. This may differ from the bytes reported by `org.eclipse.jetty.server.Response#getContentBytesWritten(Response)` due to buffering, compression, other interception or writes that bypass the servlet API. getWritten()
public boolean	isAsync()
public boolean	isClosed()
public boolean	isReady() Implements abstract jakarta.servlet.ServletOutputStream.isReady. Returns true if data can be written without blocking else returns false.
public boolean	Returns: True if any content has been written via the `jakarta.servlet.http.HttpServletResponse` API. isWritten()
private int	maximizeAggregateSpace()
public void	onFlushed(long the number of bytes flushed bytes) Invoked when bytes have been flushed to the network.
private void	onWriteComplete(boolean last, Throwable failure)
private boolean	prepareSendContent(int len, Callback callback)
public void	print(String the `String` to send to the client s) Overrides jakarta.servlet.ServletOutputStream.print. Writes a `String` to the client, without a carriage return-line feed (CRLF) character at the end.
private void	print(String s, boolean eoln)
public void	println(String the `String` to write to the client s) Overrides jakarta.servlet.ServletOutputStream.println. Writes a `String` to the client, followed by a carriage return-line feed (CRLF).
public void	recycle()
private void	releaseBuffer()
public void	reopen()
public void	resetBuffer()
public void	run() Implements java.lang.Runnable.run. Runs this operation.
public void	sendContent(ByteBuffer The whole content to send content) Blocking send of whole content.
public void	sendContent(InputStream The stream content to send in) Blocking send of stream content.
public void	sendContent(ReadableByteChannel The channel content to send in) Blocking send of channel content.
public void	sendContent(ByteBuffer The whole content to send content, final Callback The callback to use to notify success or failure callback) Asynchronous send of whole content.
public void	sendContent(InputStream The stream content to send in, Callback The callback to use to notify success or failure callback) Asynchronous send of stream content.
public void	sendContent(ReadableByteChannel The channel content to send in, Callback The callback to use to notify success or failure callback) Asynchronous send of channel content.
public void	setBufferSize(int size)
public void	setWriteListener(WriteListener the `WriteListener` that should be notified when it's possible to write writeListener) Implements abstract jakarta.servlet.ServletOutputStream.setWriteListener. Instructs the `ServletOutputStream` to invoke the provided `WriteListener` when it is possible to write
public void	softClose()
private String	stateString()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private boolean	updateApiState(Throwable failure)
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
public void	write(ByteBuffer buffer)
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.

Inherited from jakarta.servlet.ServletOutputStream:: print print print print print print println println println println println println println

public Class HttpOutput

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary