AbstractOutputBuffer (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- org.apache.coyote.http11.AbstractOutputBuffer<S>

All Implemented Interfaces:

OutputBuffer

Direct Known Subclasses:

InternalAprOutputBuffer, InternalNio2OutputBuffer, InternalNioOutputBuffer, InternalOutputBuffer
```
public abstract class AbstractOutputBuffer<S>
extends Object
implements OutputBuffer
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected OutputFilter[]`	`activeFilters` Active filter (which is actually the top of the pipeline).
`protected LinkedBlockingDeque<ByteBufferHolder>`	`bufferedWrites` For "non-blocking" writes use an external set of buffers.
`protected int`	`bufferedWriteSize` The max size of the buffered write buffer
`protected long`	`byteCount` Bytes written to client for the current request
`protected boolean`	`committed` Committed flag.
`protected OutputFilter[]`	`filterLibrary` Filter library.
`protected boolean`	`finished` Finished flag.
`protected byte[]`	`headerBuffer` The buffer used for header composition.
`protected int`	`lastActiveFilter` Index of the last active filter.
`protected OutputBuffer`	`outputStreamOutputBuffer` Underlying output buffer.
`protected int`	`pos` Position in the buffer.
`protected Response`	`response` Associated Coyote response.
`protected static StringManager`	`sm` The string manager for this package.
`protected int`	`socketBuffer` Socket buffering.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractOutputBuffer(Response response, int headerBufferSize)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractOutputBuffer(Response response, int headerBufferSize)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addActiveFilter(OutputFilter filter)` Add an output filter to the filter library.
`void`	`addFilter(OutputFilter filter)` Add an output filter to the filter library.
`protected abstract void`	`commit()`
`int`	`doWrite(ByteChunk chunk, Response res)` Write the contents of a byte chunk.
`void`	`endHeaders()` End the header block.
`void`	`endRequest()` End request.
`void`	`flush()` Flush the response.
`protected abstract boolean`	`flushBuffer(boolean block)` Writes any remaining buffered data.
`int`	`getBufferedWriteSize()`
`long`	`getBytesWritten()` Bytes written to the underlying socket.
`OutputFilter[]`	`getFilters()` Get filters.
`int`	`getSocketBuffer()` Get the socket buffer flag.
`protected boolean`	`hasBufferedData()`
`boolean`	`hasDataToWrite()`
`protected abstract boolean`	`hasMoreDataToFlush()`
`abstract void`	`init(SocketWrapper<S> socketWrapper, AbstractEndpoint<S> endpoint)`
`protected boolean`	`isBlocking()` Is standard Servlet blocking IO being used for output?
`protected boolean`	`isReady()`
`void`	`nextRequest()` End processing of current HTTP request.
`void`	`recycle()` Recycle the output buffer.
`protected abstract void`	`registerWriteInterest()`
`void`	`reset()` Reset current response.
`abstract void`	`sendAck()`
`void`	`sendHeader(MessageBytes name, MessageBytes value)` Send a header.
`void`	`sendStatus()` Send the response status line.
`void`	`setBufferedWriteSize(int bufferedWriteSize)`
`void`	`setSocketBuffer(int socketBuffer)` Set the socket buffer flag.
`void`	`write(byte[] b)` This method will write the contents of the specified byte buffer to the output stream, without filtering.
`protected void`	`write(ByteChunk bc)` This method will write the contents of the specified message bytes buffer to the output stream, without filtering.
`protected void`	`write(int i)` This method will print the specified integer to the output stream, without filtering.
`protected void`	`write(MessageBytes mb)` This method will write the contents of the specified message bytes buffer to the output stream, without filtering.
`protected void`	`write(String s)` This method will write the contents of the specified String to the output stream, without filtering.

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

- Field Detail
  - response
```
protected Response response
```
    Associated Coyote response.
  - committed
```
protected boolean committed
```
    Committed flag.
  - finished
```
protected boolean finished
```
    Finished flag.
  - headerBuffer
```
protected byte[] headerBuffer
```
    The buffer used for header composition.
  - pos
```
protected int pos
```
    Position in the buffer.
  - filterLibrary
```
protected OutputFilter[] filterLibrary
```
    Filter library. Note: Filter[0] is always the "chunked" filter.
  - activeFilters
```
protected OutputFilter[] activeFilters
```
    Active filter (which is actually the top of the pipeline).
  - lastActiveFilter
```
protected int lastActiveFilter
```
    Index of the last active filter.
  - outputStreamOutputBuffer
```
protected OutputBuffer outputStreamOutputBuffer
```
    Underlying output buffer.
  - byteCount
```
protected long byteCount
```
    Bytes written to client for the current request
  - socketBuffer
```
protected int socketBuffer
```
    Socket buffering.
  - bufferedWrites
```
protected final LinkedBlockingDeque<ByteBufferHolder> bufferedWrites
```
    For "non-blocking" writes use an external set of buffers. Although the API only allows one non-blocking write at a time, due to buffering and the possible need to write HTTP headers, there may be more than one write to the OutputBuffer.
  - bufferedWriteSize
```
protected int bufferedWriteSize
```
    The max size of the buffered write buffer
  - sm
```
protected static final StringManager sm
```
    The string manager for this package.
- Constructor Detail
  - AbstractOutputBuffer
```
protected AbstractOutputBuffer(Response response,
                    int headerBufferSize)
```
- Method Detail
  - addFilter
```
public void addFilter(OutputFilter filter)
```
    Add an output filter to the filter library.
  - getFilters
```
public OutputFilter[] getFilters()
```
    Get filters.
  - addActiveFilter
```
public void addActiveFilter(OutputFilter filter)
```
    Add an output filter to the filter library.
  - setSocketBuffer
```
public void setSocketBuffer(int socketBuffer)
```
    Set the socket buffer flag.
  - getSocketBuffer
```
public int getSocketBuffer()
```
    Get the socket buffer flag.
  - setBufferedWriteSize
```
public void setBufferedWriteSize(int bufferedWriteSize)
```
  - getBufferedWriteSize
```
public int getBufferedWriteSize()
```
  - doWrite
```
public int doWrite(ByteChunk chunk,
          Response res)
            throws IOException
```
    Write the contents of a byte chunk.
    
    Specified by:
    
    doWrite in interface OutputBuffer
    
    Parameters:
    chunk - byte chunk
    res - used to allow buffers that can be shared by multiple responses.
    
    Returns:
    number of bytes written
    
    Throws:
    
    IOException - an underlying I/O error occurred
  - getBytesWritten
```
public long getBytesWritten()
```
    Description copied from interface: OutputBuffer
    
    Bytes written to the underlying socket. This includes the effects of chunking, compression, etc.
    
    Specified by:
    
    getBytesWritten in interface OutputBuffer
    
    Returns:
    Bytes written for the current request
  - flush
```
public void flush()
           throws IOException
```
    Flush the response.
    
    Throws:
    
    IOException - an underlying I/O error occurred
  - reset
```
public void reset()
```
    Reset current response.
    
    Throws:
    
    IllegalStateException - if the response has already been committed
  - recycle
```
public void recycle()
```
    Recycle the output buffer. This should be called when closing the connection.
  - nextRequest
```
public void nextRequest()
```
    End processing of current HTTP request. Note: All bytes of the current request should have been already consumed. This method only resets all the pointers so that we are ready to parse the next HTTP request.
  - endRequest
```
public void endRequest()
                throws IOException
```
    End request.
    
    Throws:
    
    IOException - an underlying I/O error occurred
  - init
```
public abstract void init(SocketWrapper<S> socketWrapper,
        AbstractEndpoint<S> endpoint)
                   throws IOException
```
    Throws:
    
    IOException
  - sendAck
```
public abstract void sendAck()
                      throws IOException
```
    Throws:
    
    IOException
  - commit
```
protected abstract void commit()
                        throws IOException
```
    Throws:
    
    IOException
  - sendStatus
```
public void sendStatus()
```
    Send the response status line.
  - sendHeader
```
public void sendHeader(MessageBytes name,
              MessageBytes value)
```
    Send a header.
    
    Parameters:
    name - Header name
    value - Header value
  - endHeaders
```
public void endHeaders()
```
    End the header block.
  - write
```
protected void write(MessageBytes mb)
```
    This method will write the contents of the specified message bytes buffer to the output stream, without filtering. This method is meant to be used to write the response header.
    
    Parameters:
    mb - data to be written
  - write
```
protected void write(ByteChunk bc)
```
    This method will write the contents of the specified message bytes buffer to the output stream, without filtering. This method is meant to be used to write the response header.
    
    Parameters:
    bc - data to be written
  - write
```
public void write(byte[] b)
```
    This method will write the contents of the specified byte buffer to the output stream, without filtering. This method is meant to be used to write the response header.
    
    Parameters:
    b - data to be written
  - write
```
protected void write(String s)
```
    This method will write the contents of the specified String to the output stream, without filtering. This method is meant to be used to write the response header.
    
    Parameters:
    s - data to be written
  - write
```
protected void write(int i)
```
    This method will print the specified integer to the output stream, without filtering. This method is meant to be used to write the response header.
    
    Parameters:
    i - data to be written
  - hasMoreDataToFlush
```
protected abstract boolean hasMoreDataToFlush()
```
  - registerWriteInterest
```
protected abstract void registerWriteInterest()
                                       throws IOException
```
    Throws:
    
    IOException
  - flushBuffer
```
protected abstract boolean flushBuffer(boolean block)
                                throws IOException
```
    Writes any remaining buffered data.
    
    Parameters:
    block - Should this method block until the buffer is empty
    
    Returns:
    true if data remains in the buffer (which can only happen in non-blocking mode) else false.
    
    Throws:
    
    IOException
  - isBlocking
```
protected final boolean isBlocking()
```
    Is standard Servlet blocking IO being used for output?
  - isReady
```
protected final boolean isReady()
                         throws IOException
```
    Throws:
    
    IOException
  - hasDataToWrite
```
public boolean hasDataToWrite()
```
  - hasBufferedData
```
protected boolean hasBufferedData()
```

Class AbstractOutputBuffer<S>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

response

committed

finished

headerBuffer

pos

filterLibrary

activeFilters

lastActiveFilter

outputStreamOutputBuffer

byteCount

socketBuffer

bufferedWrites

bufferedWriteSize

sm

Constructor Detail

AbstractOutputBuffer

Method Detail

addFilter

getFilters

addActiveFilter

setSocketBuffer

getSocketBuffer

setBufferedWriteSize

getBufferedWriteSize

doWrite

getBytesWritten

flush

reset

recycle

nextRequest

endRequest

init

sendAck

commit

sendStatus

sendHeader

endHeaders

write

write

write

write

write

hasMoreDataToFlush

registerWriteInterest

flushBuffer

isBlocking

isReady

hasDataToWrite

hasBufferedData