InternalNio2OutputBuffer (Apache Tomcat 8.0.15 API Documentation)

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

All Implemented Interfaces:: OutputBuffer

public class InternalNio2OutputBuffer
extends AbstractOutputBuffer<Nio2Channel>

Output buffer implementation for NIO2.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class InternalNio2OutputBuffer.SocketOutputBuffer
This class is an output buffer which will write data to an output stream.

Nested Classes
Modifier and Type	Class and Description
`protected class`	`InternalNio2OutputBuffer.SocketOutputBuffer` This class is an output buffer which will write data to an output stream.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArrayList<ByteBuffer>`	`bufferedWrites` Used instead of the deque since it looks equivalent and simpler.
`protected CompletionHandler<Integer,ByteBuffer>`	`completionHandler` The completion handler used for asynchronous write operations
`protected IOException`	`e` Exception that occurred during writing.
`protected AbstractEndpoint<Nio2Channel>`	`endpoint` The associated endpoint.
`protected boolean`	`flipped` Track if the byte buffer is flipped
`protected CompletionHandler<Long,ByteBuffer[]>`	`gatherCompletionHandler` The completion handler used for asynchronous write operations
`protected boolean`	`interest` Track write interest
`protected Semaphore`	`writePending` Write pending flag.

Fields inherited from class org.apache.coyote.http11.AbstractOutputBuffer
activeFilters, bufferedWriteSize, byteCount, committed, filterLibrary, finished, headerBuffer, lastActiveFilter, outputStreamOutputBuffer, pos, response, sm, socketBuffer

Constructor Summary

Constructors
Constructor and Description

InternalNio2OutputBuffer(Response response, int headerBufferSize)
Default constructor.

Constructors
Constructor and Description
`InternalNio2OutputBuffer(Response response, int headerBufferSize)` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`commit()` Commit the response.
`protected boolean`	`flushBuffer(boolean block)` Callback to write data from the buffer.
`protected boolean`	`hasBufferedData()`
`boolean`	`hasDataToWrite()`
`protected boolean`	`hasMoreDataToFlush()`
`void`	`init(SocketWrapper<Nio2Channel> socketWrapper, AbstractEndpoint<Nio2Channel> associatedEndpoint)`
`void`	`nextRequest()` End processing of current HTTP request.
`void`	`recycle()` Recycle the output buffer.
`void`	`registerWriteInterest()`
`void`	`sendAck()` Send an acknowledgment.

Methods inherited from class org.apache.coyote.http11.AbstractOutputBuffer
addActiveFilter, addFilter, doWrite, endHeaders, endRequest, flush, getBufferedWriteSize, getBytesWritten, getFilters, getSocketBuffer, isBlocking, isReady, reset, sendHeader, sendStatus, setBufferedWriteSize, setSocketBuffer, write, write, write, write, write

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

- Field Detail
  - interest
```
protected volatile boolean interest
```
    Track write interest
  - flipped
```
protected volatile boolean flipped
```
    Track if the byte buffer is flipped
  - completionHandler
```
protected CompletionHandler<Integer,ByteBuffer> completionHandler
```
    The completion handler used for asynchronous write operations
  - gatherCompletionHandler
```
protected CompletionHandler<Long,ByteBuffer[]> gatherCompletionHandler
```
    The completion handler used for asynchronous write operations
  - writePending
```
protected Semaphore writePending
```
    Write pending flag.
  - endpoint
```
protected AbstractEndpoint<Nio2Channel> endpoint
```
    The associated endpoint.
  - bufferedWrites
```
protected ArrayList<ByteBuffer> bufferedWrites
```
    Used instead of the deque since it looks equivalent and simpler.
  - e
```
protected IOException e
```
    Exception that occurred during writing.
- Constructor Detail
  - InternalNio2OutputBuffer
```
public InternalNio2OutputBuffer(Response response,
                        int headerBufferSize)
```
    Default constructor.
- Method Detail
  - init
```
public void init(SocketWrapper<Nio2Channel> socketWrapper,
        AbstractEndpoint<Nio2Channel> associatedEndpoint)
          throws IOException
```
    Specified by:
    
    init in class AbstractOutputBuffer<Nio2Channel>
    
    Throws:
    
    IOException
  - recycle
```
public void recycle()
```
    Recycle the output buffer. This should be called when closing the connection.
    
    Overrides:
    
    recycle in class AbstractOutputBuffer<Nio2Channel>
  - nextRequest
```
public void nextRequest()
```
    Description copied from class: AbstractOutputBuffer
    
    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.
    
    Overrides:
    
    nextRequest in class AbstractOutputBuffer<Nio2Channel>
  - sendAck
```
public void sendAck()
             throws IOException
```
    Send an acknowledgment.
    
    Specified by:
    
    sendAck in class AbstractOutputBuffer<Nio2Channel>
    
    Throws:
    
    IOException
  - commit
```
protected void commit()
               throws IOException
```
    Commit the response.
    
    Specified by:
    
    commit in class AbstractOutputBuffer<Nio2Channel>
    
    Throws:
    
    IOException - an underlying I/O error occurred
  - flushBuffer
```
protected boolean flushBuffer(boolean block)
                       throws IOException
```
    Callback to write data from the buffer.
    
    Specified by:
    
    flushBuffer in class AbstractOutputBuffer<Nio2Channel>
    
    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
  - hasDataToWrite
```
public boolean hasDataToWrite()
```
    Overrides:
    
    hasDataToWrite in class AbstractOutputBuffer<Nio2Channel>
  - hasMoreDataToFlush
```
protected boolean hasMoreDataToFlush()
```
    Specified by:
    
    hasMoreDataToFlush in class AbstractOutputBuffer<Nio2Channel>
  - hasBufferedData
```
protected boolean hasBufferedData()
```
    Overrides:
    
    hasBufferedData in class AbstractOutputBuffer<Nio2Channel>
  - registerWriteInterest
```
public void registerWriteInterest()
```
    Specified by:
    
    registerWriteInterest in class AbstractOutputBuffer<Nio2Channel>

Class InternalNio2OutputBuffer

Nested Class Summary

Field Summary

Fields inherited from class org.apache.coyote.http11.AbstractOutputBuffer

Constructor Summary

Method Summary

Methods inherited from class org.apache.coyote.http11.AbstractOutputBuffer

Methods inherited from class java.lang.Object

Field Detail

interest

flipped

completionHandler

gatherCompletionHandler

writePending

endpoint

bufferedWrites

e

Constructor Detail

InternalNio2OutputBuffer

Method Detail

init

recycle

nextRequest

sendAck

commit

flushBuffer

hasDataToWrite

hasMoreDataToFlush

hasBufferedData

registerWriteInterest