AbstractServletOutputStream (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- java.io.OutputStream
- - javax.servlet.ServletOutputStream
  - - org.apache.coyote.http11.upgrade.AbstractServletOutputStream<S>

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

AprServletOutputStream, BioServletOutputStream, Nio2ServletOutputStream, NioServletOutputStream
```
public abstract class AbstractServletOutputStream<S>
extends ServletOutputStream
```

Field Summary

Fields
Modifier and Type Field and Description

protected static StringManager sm

protected SocketWrapper<S> socketWrapper

Fields
Modifier and Type	Field and Description
`protected static StringManager`	`sm`
`protected SocketWrapper<S>`	`socketWrapper`

Constructor Summary

Constructors
Constructor and Description

AbstractServletOutputStream(SocketWrapper<S> socketWrapper, int asyncWriteBufferSize)

Constructors
Constructor and Description
`AbstractServletOutputStream(SocketWrapper<S> socketWrapper, int asyncWriteBufferSize)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected abstract void`	`doClose()`
`protected abstract void`	`doFlush()`
`protected abstract int`	`doWrite(boolean block, byte[] b, int off, int len)` Abstract method to be overridden by concrete implementations.
`protected boolean`	`isCloseRequired()`
`boolean`	`isReady()` Checks if a non-blocking write will succeed.
`protected void`	`onError(Throwable t)`
`protected void`	`onWritePossible()`
`void`	`setWriteListener(WriteListener listener)` Sets the `WriteListener` for this `ServletOutputStream` and thereby switches to non-blocking IO.
`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.io.OutputStream
flush, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sm
```
protected static final StringManager sm
```
  - socketWrapper
```
protected final SocketWrapper<S> socketWrapper
```
- Constructor Detail
  - AbstractServletOutputStream
```
public AbstractServletOutputStream(SocketWrapper<S> socketWrapper,
                           int asyncWriteBufferSize)
```
- Method Detail
  - isReady
```
public final boolean isReady()
```
    Description copied from class: javax.servlet.ServletOutputStream
    
    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 contain calls WriteListener.onWritePossible().
    
    Specified by:
    
    isReady in class ServletOutputStream
    
    Returns:
    true if data can be written, else false
  - setWriteListener
```
public final void setWriteListener(WriteListener listener)
```
    Description copied from class: javax.servlet.ServletOutputStream
    
    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.
    
    Specified by:
    
    setWriteListener in class ServletOutputStream
    
    Parameters:
    listener - The non-blocking IO write listener
  - isCloseRequired
```
protected final boolean isCloseRequired()
```
  - write
```
public void write(int b)
           throws IOException
```
    Specified by:
    
    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
  - 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
  - onWritePossible
```
protected final void onWritePossible()
                              throws IOException
```
    Throws:
    
    IOException
  - onError
```
protected final void onError(Throwable t)
```
  - doWrite
```
protected abstract int doWrite(boolean block,
          byte[] b,
          int off,
          int len)
                        throws IOException
```
    Abstract method to be overridden by concrete implementations. The base class will ensure that there are no concurrent calls to this method for the same socket by ensuring that the writeLock is held when making any calls to this method.
    
    Throws:
    
    IOException
  - doFlush
```
protected abstract void doFlush()
                         throws IOException
```
    Throws:
    
    IOException
  - doClose
```
protected abstract void doClose()
                         throws IOException
```
    Throws:
    
    IOException

Class AbstractServletOutputStream<S>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.ServletOutputStream

Methods inherited from class java.io.OutputStream

Methods inherited from class java.lang.Object

Field Detail

sm

socketWrapper

Constructor Detail

AbstractServletOutputStream

Method Detail

isReady

setWriteListener

isCloseRequired

write

write

close

onWritePossible

onError

doWrite

doFlush

doClose