Interface InputBuffer

    • Method Detail

      • doRead

        @Deprecated
        int doRead​(ByteChunk chunk)
            throws IOException
        Deprecated.
        Unused. Will be removed in Tomcat 9. Use doRead(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:
        IOException - If an I/O error occurs reading from the input stream
      • doRead

        int doRead​(ApplicationBufferHandler handler)
            throws 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:
        IOException - If an I/O error occurs reading from the input stream
      • available

        int 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