Package io.undertow.servlet.spec

Class UpgradeServletOutputStream

java.lang.Object

java.io.OutputStream

jakarta.servlet.ServletOutputStream

io.undertow.servlet.spec.UpgradeServletOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class UpgradeServletOutputStream
extends ServletOutputStream

Output stream used for upgraded requests. This is different to ServletOutputStreamImpl as it does no buffering, and it not tied to an exchange.

Author:

Stuart Douglas

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UpgradeServletOutputStream(org.xnio.channels.StreamSinkChannel channel, Executor ioExecutor)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
boolean	isReady()	Returns true if data can be written without blocking else returns false.
void	setWriteListener(WriteListener writeListener)	Instructs the ServletOutputStream to invoke the provided WriteListener when it is possible to write
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class jakarta.servlet.ServletOutputStream

print, print, print, print, print, print, print, println, println, println, println, println, println, println, println

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UpgradeServletOutputStream

protected UpgradeServletOutputStream(org.xnio.channels.StreamSinkChannel channel,
 Executor ioExecutor)

Method Details

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

isReady

public boolean isReady()

Description copied from class: ServletOutputStream

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

If this method returns false and a WriteListener has been set with ServletOutputStream.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.

Specified by:

isReady in class ServletOutputStream

Returns:

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

See Also:

• WriteListener

setWriteListener

public void setWriteListener(WriteListener writeListener)

Description copied from class: ServletOutputStream

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

Specified by:

setWriteListener in class ServletOutputStream

Parameters:

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