Package org.apache.coyote
Interface InputBuffer
- 
- All Known Subinterfaces:
- InputFilter
 - All Known Implementing Classes:
- AjpProcessor.SocketInputBuffer,- BufferedInputFilter,- ChunkedInputFilter,- Http11InputBuffer,- IdentityInputFilter,- SavedRequestInputFilter,- VoidInputFilter
 
 public interface InputBufferThis class is only for internal use in the protocol implementation. All reading from Tomcat (or adapter) should be done using Request.doRead().
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description intavailable()Obtain an estimate of the number of bytes that can be read without blocking.intdoRead(ByteChunk chunk)Deprecated.Unused.intdoRead(ApplicationBufferHandler handler)Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler.
 
- 
- 
- 
Method Detail- 
doRead@Deprecated int doRead(ByteChunk chunk) throws java.io.IOException Deprecated.Unused. Will be removed in Tomcat 9. UsedoRead(ApplicationBufferHandler)Read from the input stream into the given buffer. IMPORTANT: the current model assumes that the protocol will 'own' the buffer and return a pointer to it in ByteChunk (i.e. the param will have chunk.getBytes()==null before call, and the result after the call).- Parameters:
- chunk- The buffer to read data into.
- Returns:
- The number of bytes that have been added to the buffer or -1 for end of stream
- Throws:
- java.io.IOException- If an I/O error occurs reading from the input stream
 
 - 
doReadint doRead(ApplicationBufferHandler handler) throws java.io.IOException Read from the input stream into the ByteBuffer provided by the ApplicationBufferHandler. IMPORTANT: the current model assumes that the protocol will 'own' the ByteBuffer and return a pointer to it.- Parameters:
- handler- ApplicationBufferHandler that provides the buffer to read data into.
- Returns:
- The number of bytes that have been added to the buffer or -1 for end of stream
- Throws:
- java.io.IOException- If an I/O error occurs reading from the input stream
 
 - 
availableint available() Obtain an estimate of the number of bytes that can be read without blocking. Typically, this will be the number of available bytes known to be buffered.- Returns:
- The number of bytes that can be read without blocking
 
 
- 
 
-