Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	ServletOutputStreamImpl.WriteChannelListener

Field Summary

Modifier and Type	Field and Description
private AsyncContextImpl	asyncContext
private volatile boolean	asyncIoStarted
private ByteBuffer	buffer
private Integer	bufferSize
private ByteBuffer[]	buffersToWrite buffers that are queued up to be written via async writes.
private StreamSinkChannel	channel
private static final int	FLAG_CLOSED
private static final int	FLAG_DELEGATE_SHUTDOWN
private static final int	FLAG_IN_CALLBACK
private static final int	FLAG_READY
private static final int	FLAG_WRITE_STARTED
private ServletOutputStreamImpl.WriteChannelListener	internalListener
private WriteListener	listener
private static final int	MAX_BUFFERS_TO_ALLOCATE
private FileChannel	pendingFile
private PooledByteBuffer	pooledBuffer
private final ServletRequestContext	servletRequestContext
private volatile int	state
private static final AtomicIntegerFieldUpdater<ServletOutputStreamImpl>	stateUpdater
private long	written

Constructor Summary

Access	Constructor and Description
public	ServletOutputStreamImpl(final ServletRequestContext servletRequestContext) Construct a new instance.
public	ServletOutputStreamImpl(final ServletRequestContext servletRequestContext, int bufferSize) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
private ByteBuffer	buffer()
private void	clearFlags(int flags)
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	closeAsync() Closes the channel, and flushes any data out using async IO This is used in two situations, if an output stream is not closed when a request is done, and when performing a close on a stream that is in async mode
private void	createChannel()
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.
private boolean	flushBufferAsync(final boolean writeFinal)
public void	flushInternal()
pack-priv ServletRequestContext	getServletRequestContext()
public boolean	isClosed()
public boolean	isReady() Implements abstract jakarta.servlet.ServletOutputStream.isReady. Returns true if data can be written without blocking else returns false.
pack-priv long	remainingContentLength()
public void	resetBuffer()
public void	setBufferSize(final int size)
private void	setFlags(int flags)
public void	setWriteListener(final 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	transferFrom(FileChannel source) Implements io.undertow.io.BufferWritableOutputStream.transferFrom.
pack-priv ByteBuffer	Returns: The underlying buffer underlyingBuffer() Returns the underlying buffer.
pack-priv void	updateWritten(final long len)
pack-priv void	updateWrittenAsync(final long len)
public void	write(final int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(final byte[] the data. b) Overrides java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream.
public void	write(final byte[] the data. b, final int the start offset in the data. off, final 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[] buffers) Implements io.undertow.io.BufferWritableOutputStream.write.
public void	write(ByteBuffer byteBuffer) Implements io.undertow.io.BufferWritableOutputStream.write.
private void	writeAsync(byte[] b, int off, int len)
private void	writeBufferBlocking(final boolean writeFinal)
private void	writeTooLargeForBuffer(byte[] b, int off, int len, ByteBuffer buffer)

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

Field Detail

asyncContext	back to summary
private AsyncContextImpl asyncContext

asyncIoStarted	back to summary
private volatile boolean asyncIoStarted

buffer	back to summary
private ByteBuffer buffer

bufferSize	back to summary
private Integer bufferSize

buffersToWrite	back to summary
private ByteBuffer[] buffersToWrite buffers that are queued up to be written via async writes. This will include `buffer` as the first element, and maybe a user supplied buffer that did not fit

channel	back to summary
private StreamSinkChannel channel

FLAG_CLOSED	back to summary
private static final int FLAG_CLOSED

FLAG_DELEGATE_SHUTDOWN	back to summary
private static final int FLAG_DELEGATE_SHUTDOWN

FLAG_IN_CALLBACK	back to summary
private static final int FLAG_IN_CALLBACK

FLAG_READY	back to summary
private static final int FLAG_READY

FLAG_WRITE_STARTED	back to summary
private static final int FLAG_WRITE_STARTED

internalListener	back to summary
private ServletOutputStreamImpl.WriteChannelListener internalListener

listener	back to summary
private WriteListener listener

MAX_BUFFERS_TO_ALLOCATE	back to summary
private static final int MAX_BUFFERS_TO_ALLOCATE

pendingFile	back to summary
private FileChannel pendingFile

pooledBuffer	back to summary
private PooledByteBuffer pooledBuffer

servletRequestContext	back to summary
private final ServletRequestContext servletRequestContext

state	back to summary
private volatile int state

stateUpdater	back to summary
private static final AtomicIntegerFieldUpdater<ServletOutputStreamImpl> stateUpdater

written	back to summary
private long written

Constructor Detail

ServletOutputStreamImpl	back to summary
public ServletOutputStreamImpl(final ServletRequestContext servletRequestContext) Construct a new instance. No write timeout is configured.

ServletOutputStreamImpl	back to summary
public ServletOutputStreamImpl(final ServletRequestContext servletRequestContext, int bufferSize) Construct a new instance. No write timeout is configured.

Method Detail

buffer	back to summary
private ByteBuffer buffer()

clearFlags	back to summary
private void clearFlags(int flags)

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Exceptions

IOException:: if an I/O error occurs.

closeAsync	back to summary
public void closeAsync() throws IOException Closes the channel, and flushes any data out using async IO This is used in two situations, if an output stream is not closed when a request is done, and when performing a close on a stream that is in async mode

closeAsync

back to summary

public void closeAsync() throws IOException

Closes the channel, and flushes any data out using async IO

This is used in two situations, if an output stream is not closed when a request is done, and when performing a close on a stream that is in async mode

createChannel	back to summary
private void createChannel()

flush back to summary

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Doc from java.io.OutputStream.flush. Flushes this output stream and forces any buffered output bytes to be written out. The general contract of `flush` is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Exceptions IOException: if an I/O error occurs.

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Exceptions

IOException:: if an I/O error occurs.

flushBufferAsync	back to summary
private boolean flushBufferAsync(final boolean writeFinal) throws IOException

flushInternal	back to summary
public void flushInternal() throws IOException

getServletRequestContext	back to summary
pack-priv ServletRequestContext getServletRequestContext()

isClosed	back to summary
public boolean isClosed()

isReady back to summary

isReady	back to summary
public boolean isReady() Implements abstract jakarta.servlet.ServletOutputStream.isReady. Doc from jakarta.servlet.ServletOutputStream.isReady. Returns true if data can be written without blocking else returns false. If this method returns false and a `WriteListener` has been set with `setWriteListener(WriteListener)`, then container will subsequently invoke `WriteListener#onWritePossible()` once a write operation becomes possible without blocking. Other than the initial call, `WriteListener#onWritePossible()` will only be called if and only if this method is called and returns false. Returns:boolean `true` if data can be written without blocking, otherwise returns `false`. Annotations @Override

public boolean isReady()

Implements abstract jakarta.servlet.ServletOutputStream.isReady.

Doc from jakarta.servlet.ServletOutputStream.isReady.

Returns true if data can be written without blocking else returns false.

If this method returns false and a WriteListener has been set with setWriteListener(WriteListener), then container will subsequently invoke WriteListener#onWritePossible() once a write operation becomes possible without blocking. Other than the initial call, WriteListener#onWritePossible() will only be called if and only if this method is called and returns false.

Returns:boolean

true if data can be written without blocking, otherwise returns false.

Annotations

@Override

remainingContentLength	back to summary
pack-priv long remainingContentLength() throws IOException

resetBuffer	back to summary
public void resetBuffer()

setBufferSize	back to summary
public void setBufferSize(final int size)

setFlags	back to summary
private void setFlags(int flags)

setWriteListener back to summary

setWriteListener	back to summary
public void setWriteListener(final WriteListener writeListener) Implements abstract jakarta.servlet.ServletOutputStream.setWriteListener. Doc from jakarta.servlet.ServletOutputStream.setWriteListener. Instructs the `ServletOutputStream` to invoke the provided `WriteListener` when it is possible to write Parameters writeListener:WriteListener the `WriteListener` that should be notified when it's possible to write Annotations @Override

public void setWriteListener(final WriteListener writeListener)

Implements abstract jakarta.servlet.ServletOutputStream.setWriteListener.

Doc from jakarta.servlet.ServletOutputStream.setWriteListener.

Instructs the ServletOutputStream to invoke the provided WriteListener when it is possible to write

Parameters

writeListener:WriteListener: the WriteListener that should be notified when it's possible to write

Annotations

@Override

transferFrom	back to summary
public void transferFrom(FileChannel source) throws IOException Implements io.undertow.io.BufferWritableOutputStream.transferFrom. Annotations @Override

transferFrom

back to summary

public void transferFrom(FileChannel source) throws IOException

Implements io.undertow.io.BufferWritableOutputStream.transferFrom.

Annotations

@Override

underlyingBuffer back to summary

underlyingBuffer	back to summary
pack-priv ByteBuffer underlyingBuffer() Returns the underlying buffer. If this has not been created yet then it is created. Callers that use this method must call `updateWritten(long)` to update the written amount. This allows the buffer to be filled directly, which can be more efficient. This method is basically a hack that should only be used by the print writer Returns:ByteBuffer The underlying buffer

pack-priv ByteBuffer underlyingBuffer()

Returns the underlying buffer. If this has not been created yet then it is created.

Callers that use this method must call updateWritten(long) to update the written amount.

This allows the buffer to be filled directly, which can be more efficient.

This method is basically a hack that should only be used by the print writer

Returns:ByteBuffer: The underlying buffer

updateWritten	back to summary
pack-priv void updateWritten(final long len) throws IOException

updateWrittenAsync	back to summary
pack-priv void updateWrittenAsync(final long len) throws IOException

write back to summary

write	back to summary
public void write(final int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(final int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

write	back to summary
public void write(final byte[] b) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream. The general contract for `write(b)` is that it should have exactly the same effect as the call `write(b, 0, b.length)`. Parameters b:byte[] the data. Exceptions IOException: if an I/O error occurs.

public void write(final byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters

b:byte[]: the data.

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(final byte[] b, final int off, final int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public void write(final byte[] b, final int off, final int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

write	back to summary
public void write(ByteBuffer[] buffers) throws IOException Implements io.undertow.io.BufferWritableOutputStream.write. Annotations @Override

write

back to summary

public void write(ByteBuffer[] buffers) throws IOException

Implements io.undertow.io.BufferWritableOutputStream.write.

Annotations

@Override

write

back to summary

public void write(ByteBuffer byteBuffer) throws IOException

Implements io.undertow.io.BufferWritableOutputStream.write.

Annotations

@Override

writeAsync	back to summary
private void writeAsync(byte[] b, int off, int len) throws IOException

writeBufferBlocking	back to summary
private void writeBufferBlocking(final boolean writeFinal) throws IOException

writeTooLargeForBuffer	back to summary
private void writeTooLargeForBuffer(byte[] b, int off, int len, ByteBuffer buffer) throws IOException

io.undertow.servlet.spec back to summary

private Class ServletOutputStreamImpl.WriteChannelListener

Class Inheritance

extends Object
implements ChannelListener<StreamSinkChannel>

java.lang.Object
io.undertow.servlet.spec.ServletOutputStreamImpl.WriteChannelListener

All Implemented Interfaces

org.xnio.ChannelListener, java.util.EventListener

Constructor Summary

Access	Constructor and Description
private	WriteChannelListener()

Method Summary

Modifier and Type	Method and Description
private void	handleError(final Throwable t)
public void	handleEvent(final StreamSinkChannel the channel event aChannel) Implements org.xnio.ChannelListener.handleEvent. Handle the event on this channel.