io.undertow.servlet.spec

Class UpgradeServletOutputStream

java.lang.Object

java.io.OutputStream

javax.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 and Description
protected	UpgradeServletOutputStream(StreamSinkChannel channel, Executor ioExecutor)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
boolean	isReady() This method can be used to determine if data can be written without blocking.
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 javax.servlet.ServletOutputStream

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

Methods inherited from class java.lang.Object

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

Constructor Detail

UpgradeServletOutputStream

protected UpgradeServletOutputStream(StreamSinkChannel channel,
                                     Executor ioExecutor)

Method Detail

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 Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

isReady

public boolean isReady()

Description copied from class: ServletOutputStream

This method can be used to determine if data can be written without blocking.

Specified by:

isReady in class ServletOutputStream

Returns:

true if a write to this ServletOutputStream will succeed, otherwise returns false.

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