Class HttpInput

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, java.lang.Runnable
    Direct Known Subclasses:
    HttpInputOverHTTP

    public class HttpInput
    extends javax.servlet.ServletInputStream
    implements java.lang.Runnable
    HttpInput provides an implementation of ServletInputStream for HttpChannel.

    Content may arrive in patterns such as [content(), content(), messageComplete()] so that this class maintains two states: the content state that tells whether there is content to consume and the EOF state that tells whether an EOF has arrived. Only once the content has been consumed the content state is moved to the EOF state.

    • Method Detail

      • recycle

        public void recycle()
      • getInterceptor

        public HttpInput.Interceptor getInterceptor()
        Returns:
        The current Interceptor, or null if none set
      • setInterceptor

        public void setInterceptor​(HttpInput.Interceptor interceptor)
        Set the interceptor.
        Parameters:
        interceptor - The interceptor to use.
      • available

        public int available()
        Overrides:
        available in class java.io.InputStream
      • wake

        protected void wake()
      • read

        public int read()
                 throws java.io.IOException
        Specified by:
        read in class java.io.InputStream
        Throws:
        java.io.IOException
      • read

        public int read​(byte[] b,
                        int off,
                        int len)
                 throws java.io.IOException
        Overrides:
        read in class java.io.InputStream
        Throws:
        java.io.IOException
      • produceContent

        protected void produceContent()
                               throws java.io.IOException
        Called when derived implementations should attempt to produce more Content and add it via addContent(Content). For protocols that are constantly producing (eg HTTP2) this can be left as a noop;
        Throws:
        java.io.IOException - if unable to produce content
      • asyncReadProduce

        public void asyncReadProduce()
                              throws java.io.IOException
        Called by channel when asynchronous IO needs to produce more content
        Throws:
        java.io.IOException - if unable to produce content
      • nextContent

        protected HttpInput.Content nextContent()
                                         throws java.io.IOException
        Get the next content from the inputQ, calling produceContent() if need be. EOF is processed and state changed.
        Returns:
        the content or null if none available.
        Throws:
        java.io.IOException - if retrieving the content fails
      • nextNonSentinelContent

        protected HttpInput.Content nextNonSentinelContent()
        Poll the inputQ for Content. Consumed buffers and HttpInput.SentinelContents are removed and EOF state updated if need be.
        Returns:
        Content or null
      • produceNextContext

        protected HttpInput.Content produceNextContext()
                                                throws java.io.IOException
        Get the next readable from the inputQ, calling produceContent() if need be. EOF is NOT processed and state is not changed.
        Returns:
        the content or EOF or null if none available.
        Throws:
        java.io.IOException - if retrieving the content fails
      • get

        protected int get​(HttpInput.Content content,
                          byte[] buffer,
                          int offset,
                          int length)
        Copies the given content into the given byte buffer.
        Parameters:
        content - the content to copy from
        buffer - the buffer to copy into
        offset - the buffer offset to start copying from
        length - the space available in the buffer
        Returns:
        the number of bytes actually copied
      • skip

        protected void skip​(HttpInput.Content content,
                            int length)
        Consumes the given content. Calls the content succeeded if all content consumed.
        Parameters:
        content - the content to consume
        length - the number of bytes to consume
      • blockForContent

        protected void blockForContent()
                                throws java.io.IOException
        Blocks until some content or some end-of-file event arrives.
        Throws:
        java.io.IOException - if the wait is interrupted
      • addContent

        public boolean addContent​(HttpInput.Content content)
        Adds some content to this input stream.
        Parameters:
        content - the content to add
        Returns:
        true if content channel woken for read
      • hasContent

        public boolean hasContent()
      • unblock

        public void unblock()
      • getContentConsumed

        public long getContentConsumed()
      • getContentReceived

        public long getContentReceived()
      • earlyEOF

        public boolean earlyEOF()
        This method should be called to signal that an EOF has been detected before all the expected content arrived.

        Typically this will result in an EOFException being thrown from a subsequent read rather than a -1 return.

        Returns:
        true if content channel woken for read
      • eof

        public boolean eof()
        This method should be called to signal that all the expected content arrived.
        Returns:
        true if content channel woken for read
      • consumeAll

        public boolean consumeAll()
        Consume all available content without blocking. Raw content is counted in the getContentReceived() statistics, but is not intercepted nor counted in the getContentConsumed() statistics
        Returns:
        True if EOF was reached, false otherwise.
      • isError

        public boolean isError()
      • isAsync

        public boolean isAsync()
      • isFinished

        public boolean isFinished()
        Specified by:
        isFinished in class javax.servlet.ServletInputStream
      • isReady

        public boolean isReady()
        Specified by:
        isReady in class javax.servlet.ServletInputStream
      • setReadListener

        public void setReadListener​(javax.servlet.ReadListener readListener)
        Specified by:
        setReadListener in class javax.servlet.ServletInputStream
      • onIdleTimeout

        public boolean onIdleTimeout​(java.lang.Throwable x)
      • failed

        public boolean failed​(java.lang.Throwable x)
      • run

        public void run()
        Specified by:
        run in interface java.lang.Runnable
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object