Undertow 2.3.12.Final · io.undertow.io.UndertowOutputStream

Modifier and Type	Field and Description
private ByteBuffer	buffer
private StreamSinkChannel	channel
private final long	contentLength
private final HttpServerExchange	exchange
private static final int	FLAG_CLOSED
private static final int	FLAG_WRITE_STARTED
private static final int	MAX_BUFFERS_TO_ALLOCATE
private PooledByteBuffer	pooledBuffer
private int	state
private long	written

Access	Constructor and Description
public	UndertowOutputStream(HttpServerExchange The exchange exchange) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
private ByteBuffer	buffer()
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	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 long	getBytesWritten()
private static boolean	isHeadRequestWithContentLength(HttpServerExchange exchange)
public void	resetBuffer() If the response has not yet been written to the client this method will clear the streams buffer, invalidating any content that has already been written.
public void	transferFrom(FileChannel source) Implements io.undertow.io.BufferWritableOutputStream.transferFrom.
pack-priv void	updateWritten(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	writeBufferBlocking(final boolean writeFinal)

Inherited from java.io.OutputStream:: nullOutputStream

buffer	back to summary
private ByteBuffer buffer

channel	back to summary
private StreamSinkChannel channel

contentLength	back to summary
private final long contentLength

exchange	back to summary
private final HttpServerExchange exchange

FLAG_CLOSED	back to summary
private static final int FLAG_CLOSED

FLAG_WRITE_STARTED	back to summary
private static final int FLAG_WRITE_STARTED

MAX_BUFFERS_TO_ALLOCATE	back to summary
private static final int MAX_BUFFERS_TO_ALLOCATE

pooledBuffer	back to summary
private PooledByteBuffer pooledBuffer

state	back to summary
private int state

written	back to summary
private long written

UndertowOutputStream	back to summary
public UndertowOutputStream(HttpServerExchange exchange) Construct a new instance. No write timeout is configured. Parameters exchange:HttpServerExchange The exchange

Method Detail

buffer	back to summary
private ByteBuffer buffer()

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.

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.

getBytesWritten	back to summary
public long getBytesWritten()

isHeadRequestWithContentLength	back to summary
private static boolean isHeadRequestWithContentLength(HttpServerExchange exchange)

resetBuffer	back to summary
public void resetBuffer() If the response has not yet been written to the client this method will clear the streams buffer, invalidating any content that has already been written. If any content has already been sent to the client then this method will throw and IllegalStateException Exceptions IllegalStateException: If the response has been committed

resetBuffer

back to summary

public void resetBuffer()

If the response has not yet been written to the client this method will clear the streams buffer, invalidating any content that has already been written. If any content has already been sent to the client then this method will throw and IllegalStateException

Exceptions

IllegalStateException:: If the response has been committed

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

updateWritten	back to summary
pack-priv void updateWritten(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

write

back to summary

public void write(ByteBuffer byteBuffer) throws IOException

Implements io.undertow.io.BufferWritableOutputStream.write.

Annotations

@Override

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

public Class UndertowOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail