AbstractAjpProcessor.SocketOutputBuffer (Apache Tomcat 7.0.104 API Documentation)

org.apache.coyote.ajp

## Class AbstractAjpProcessor.SocketOutputBuffer

- java.lang.Object
- - org.apache.coyote.ajp.AbstractAjpProcessor.SocketOutputBuffer

- All Implemented Interfaces:
    OutputBuffer
  Enclosing class:
    AbstractAjpProcessor<S>

      protected class AbstractAjpProcessor.SocketOutputBuffer
      extends Object
      implements OutputBuffer

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

- - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `AbstractAjpProcessor.SocketOutputBuffer()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `int` | `doWrite(ByteChunk chunk, Response res)` Write chunk.
    `long` | `getBytesWritten()` Bytes written to the underlying socket.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### AbstractAjpProcessor.SocketOutputBuffer

          protected AbstractAjpProcessor.SocketOutputBuffer()

  - ### Method Detail

    - #### doWrite

          public int doWrite(ByteChunk chunk,
                    Response res)
                      throws IOException

      Write chunk.
      Specified by:
        `doWrite` in interface `OutputBuffer`
      Parameters:
        `chunk` - data to write
        `res` - The response to which the data should be written. (Should be the response already associated with the OutputBuffer).
      Returns:
        The number of bytes written which may be less than available in the input chunk
      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

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.