InternalOutputBuffer (Apache Tomcat 7.0.67 API Documentation)

java.lang.Object
- org.apache.coyote.http11.AbstractOutputBuffer<java.net.Socket>
- - org.apache.coyote.http11.InternalOutputBuffer

All Implemented Interfaces:: OutputBuffer, ByteChunk.ByteOutputChannel

public class InternalOutputBuffer
extends AbstractOutputBuffer<java.net.Socket>
implements ByteChunk.ByteOutputChannel

Output buffer.

Author:: Remy Maucherat

Nested Class Summary

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

Field Summary

Fields
Modifier and Type Field and Description

protected java.io.OutputStream outputStream
Underlying output stream.
- Fields inherited from class org.apache.coyote.http11.AbstractOutputBuffer
  activeFilters, buf, byteCount, committed, filterLibrary, finished, lastActiveFilter, outputStreamOutputBuffer, pos, response, sm

Fields
Modifier and Type	Field and Description
`protected java.io.OutputStream`	`outputStream` Underlying output stream.

Constructor Summary

Constructors
Constructor and Description

InternalOutputBuffer(Response response, int headerBufferSize)
Default constructor.

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

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`commit()` Commit the response.
`void`	`endRequest()` End request.
`void`	`flush()` Flush the response.
`void`	`init(SocketWrapper<java.net.Socket> socketWrapper, AbstractEndpoint<java.net.Socket> endpoint)`
`void`	`nextRequest()` End processing of current HTTP request.
`void`	`realWriteBytes(byte[] cbuf, int off, int len)` Callback to write data from the buffer.
`void`	`recycle()` Recycle the output buffer.
`void`	`sendAck()` Send an acknowledgment.
`void`	`setSocketBuffer(int socketBufferSize)` Set the socket buffer size.

Methods inherited from class org.apache.coyote.http11.AbstractOutputBuffer
addActiveFilter, addFilter, doWrite, endHeaders, getBytesWritten, getFilters, reset, sendHeader, sendStatus, write, 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
  - outputStream
```
protected java.io.OutputStream outputStream
```
    Underlying output stream. Note: protected to assist with unit testing
- Constructor Detail
  - InternalOutputBuffer
```
public InternalOutputBuffer(Response response,
                    int headerBufferSize)
```
    Default constructor.
- Method Detail
  - setSocketBuffer
```
public void setSocketBuffer(int socketBufferSize)
```
    Set the socket buffer size.
  - init
```
public void init(SocketWrapper<java.net.Socket> socketWrapper,
        AbstractEndpoint<java.net.Socket> endpoint)
          throws java.io.IOException
```
    Specified by:
    
    init in class AbstractOutputBuffer<java.net.Socket>
    
    Throws:
    
    java.io.IOException
  - flush
```
public void flush()
           throws java.io.IOException
```
    Flush the response.
    
    Overrides:
    
    flush in class AbstractOutputBuffer<java.net.Socket>
    
    Throws:
    
    java.io.IOException - an underlying I/O error occurred
  - recycle
```
public void recycle()
```
    Recycle the output buffer. This should be called when closing the connection.
    
    Overrides:
    
    recycle in class AbstractOutputBuffer<java.net.Socket>
  - 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.
    
    Overrides:
    
    nextRequest in class AbstractOutputBuffer<java.net.Socket>
  - endRequest
```
public void endRequest()
                throws java.io.IOException
```
    End request.
    
    Overrides:
    
    endRequest in class AbstractOutputBuffer<java.net.Socket>
    
    Throws:
    
    java.io.IOException - an underlying I/O error occurred
  - sendAck
```
public void sendAck()
             throws java.io.IOException
```
    Send an acknowledgment.
    
    Specified by:
    
    sendAck in class AbstractOutputBuffer<java.net.Socket>
    
    Throws:
    
    java.io.IOException
  - commit
```
protected void commit()
               throws java.io.IOException
```
    Commit the response.
    
    Specified by:
    
    commit in class AbstractOutputBuffer<java.net.Socket>
    
    Throws:
    
    java.io.IOException - an underlying I/O error occurred
  - realWriteBytes
```
public void realWriteBytes(byte[] cbuf,
                  int off,
                  int len)
                    throws java.io.IOException
```
    Callback to write data from the buffer.
    
    Specified by:
    
    realWriteBytes in interface ByteChunk.ByteOutputChannel
    
    Throws:
    
    java.io.IOException

Class InternalOutputBuffer

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

outputStream

Constructor Detail

InternalOutputBuffer

Method Detail

setSocketBuffer

init

flush

recycle

nextRequest

endRequest

sendAck

commit

realWriteBytes