Tomcat 10.1.19 · org.apache.coyote.http11.upgrade.UpgradeServletOutputStream

Modifier and Type	Field and Description
private volatile boolean	closed
private volatile boolean	flushing
private volatile WriteListener	listener
private static final Log	log
private final UpgradeProcessorBase	processor
private boolean	registered
private final Object	registeredLock
private static final StringManager	sm
private final SocketWrapperBase<?>	socketWrapper
private final UpgradeInfo	upgradeInfo
private final Object	writeLock

Access	Constructor and Description
public	UpgradeServletOutputStream(UpgradeProcessorBase processor, SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo)

Method Summary

Modifier and Type	Method and Description
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.
private void	flushInternal(boolean block, boolean updateFlushing)
pack-priv final boolean	isClosed()
public final boolean	isReady() Implements abstract jakarta.servlet.ServletOutputStream.isReady. Checks if a non-blocking write will succeed.
private void	onError(Throwable t)
pack-priv final void	onWritePossible()
private void	preWriteChecks()
public final void	setWriteListener(WriteListener The non-blocking IO write listener listener) Implements abstract jakarta.servlet.ServletOutputStream.setWriteListener. Sets the `WriteListener` for this `ServletOutputStream` and thereby switches to non-blocking IO.
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
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.
private void	writeInternal(byte[] b, int off, int len) Must hold writeLock to call this method.

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

closed	back to summary
private volatile boolean closed

flushing	back to summary
private volatile boolean flushing

listener	back to summary
private volatile WriteListener listener

log	back to summary
private static final Log log

processor	back to summary
private final UpgradeProcessorBase processor

registered	back to summary
private boolean registered

registeredLock	back to summary
private final Object registeredLock

sm	back to summary
private static final StringManager sm

socketWrapper	back to summary
private final SocketWrapperBase<?> socketWrapper

upgradeInfo	back to summary
private final UpgradeInfo upgradeInfo

writeLock	back to summary
private final Object writeLock

UpgradeServletOutputStream	back to summary
public UpgradeServletOutputStream(UpgradeProcessorBase processor, SocketWrapperBase<?> socketWrapper, UpgradeInfo upgradeInfo)

Method Detail

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. Annotations @Override 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.

Annotations

@Override

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. Annotations @Override 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.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

flushInternal	back to summary
private void flushInternal(boolean block, boolean updateFlushing) throws IOException

isClosed	back to summary
pack-priv final boolean isClosed()

isReady back to summary

isReady	back to summary
public final boolean isReady() Implements abstract jakarta.servlet.ServletOutputStream.isReady. Doc from jakarta.servlet.ServletOutputStream.isReady. Checks if a non-blocking write will succeed. If this returns `false`, it will cause a callback to `WriteListener#onWritePossible()` when the buffer has emptied. If this method returns `false` no further data must be written until the container calls `WriteListener#onWritePossible()`. Returns:boolean `true` if data can be written, else `false` Annotations @Override

public final boolean isReady()

Implements abstract jakarta.servlet.ServletOutputStream.isReady.

Doc from jakarta.servlet.ServletOutputStream.isReady.

Checks if a non-blocking write will succeed. If this returns false, it will cause a callback to WriteListener#onWritePossible() when the buffer has emptied. If this method returns false no further data must be written until the container calls WriteListener#onWritePossible().

Returns:boolean

true if data can be written, else false

Annotations

@Override

onError	back to summary
private void onError(Throwable t)

onWritePossible	back to summary
pack-priv final void onWritePossible()

preWriteChecks	back to summary
private void preWriteChecks()

setWriteListener back to summary

setWriteListener	back to summary
public final void setWriteListener(WriteListener listener) Implements abstract jakarta.servlet.ServletOutputStream.setWriteListener. Doc from jakarta.servlet.ServletOutputStream.setWriteListener. Sets the `WriteListener` for this `ServletOutputStream` and thereby switches to non-blocking IO. It is only valid to switch to non-blocking IO within async processing or HTTP upgrade processing. Parameters listener:WriteListener The non-blocking IO write listener Annotations @Override

public final void setWriteListener(WriteListener listener)

Implements abstract jakarta.servlet.ServletOutputStream.setWriteListener.

Doc from jakarta.servlet.ServletOutputStream.setWriteListener.

Sets the WriteListener for this ServletOutputStream and thereby switches to non-blocking IO. It is only valid to switch to non-blocking IO within async processing or HTTP upgrade processing.

Parameters

listener:WriteListener: The non-blocking IO write listener

Annotations

@Override

write back to summary

write	back to summary
public void write(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`. Annotations @Override 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(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.

Annotations

@Override

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(byte[] b, int off, 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. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public void write(byte[] b, int off, 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.

Annotations

@Override

Exceptions

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

writeInternal	back to summary
private void writeInternal(byte[] b, int off, int len) throws IOException Must hold writeLock to call this method.

public Class UpgradeServletOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail