Class AsynchronousBodyInputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable

    class AsynchronousBodyInputStream
    extends BodyInputStream
    TODO Some of the operations added for async. support (e.g.) can be also supported in sync. mode

    Body stream that can operate either synchronously or asynchronously. See BodyInputStream for details.

    • Field Detail

      • EOF

        private static final java.nio.ByteBuffer EOF
      • ERROR

        private static final java.nio.ByteBuffer ERROR
      • callReadListener

        private boolean callReadListener
      • t

        private java.lang.Throwable t
      • closedForInput

        private boolean closedForInput
      • listenerExecutor

        private java.util.concurrent.ExecutorService listenerExecutor
      • data

        private java.util.Deque<java.nio.ByteBuffer> data
    • Constructor Detail

      • AsynchronousBodyInputStream

        AsynchronousBodyInputStream()
    • Method Detail

      • setListenerExecutor

        void setListenerExecutor​(java.util.concurrent.ExecutorService listenerExecutor)
      • isReady

        public boolean isReady()
        Description copied from class: BodyInputStream
        Returns true if data can be read without blocking else returns false.

        If the stream is in ASYNCHRONOUS mode and the user attempts to read from it even though this method returns false, an IllegalStateException is thrown.

        Specified by:
        isReady in class BodyInputStream
        Returns:
        true if data can be obtained without blocking, otherwise returns false.
      • setReadListener

        public void setReadListener​(ReadListener readListener)
        Description copied from class: BodyInputStream
        Instructs the stream to invoke the provided ReadListener when it is possible to read.

        If the stream is in UNDECIDED state, invoking this method will commit the stream to ASYNCHRONOUS mode.

        Specified by:
        setReadListener in class BodyInputStream
        Parameters:
        readListener - the ReadListener that should be notified when it's possible to read.
      • 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
      • doRead

        private byte doRead()
      • available

        public int available()
                      throws java.io.IOException
        Description copied from class: NonBlockingInputStream
        Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

        Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

        A subclass' implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the InputStream.close() method.

        The default implementation of this method in NonBlockingInputStream throws an UnsupportedOperationException. This method must be overridden by subclasses. The overriding implementations must guarantee non-blocking behavior of the method. The overriding implementation must also guarantee that a non-empty stream does not return zero from the method. IOW, it must be possible to use the method for empty check: stream.available() == 0

        Overrides:
        available in class NonBlockingInputStream
        Returns:
        an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream or the stream is empty.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • skip

        public long skip​(long n)
                  throws java.io.IOException
        Overrides:
        skip in class java.io.InputStream
        Throws:
        java.io.IOException
      • tryRead

        public int tryRead()
                    throws java.io.IOException
        Description copied from class: NonBlockingInputStream
        Behaves mostly like InputStream.read(). The main difference is that this method is non-blocking. In case there are no data available to be read, the method returns NonBlockingInputStream.NOTHING immediately.
        Specified by:
        tryRead in class NonBlockingInputStream
        Returns:
        next byte of data, -1 if end of the stream has been reached or NonBlockingInputStream.NOTHING in case no data are available to be read at the moment.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • tryRead

        public int tryRead​(byte[] b)
                    throws java.io.IOException
        Description copied from class: NonBlockingInputStream
        Behaves mostly like InputStream.read(byte[]). The main difference is that this method is non-blocking. In case there are no data available to be read, the method returns zero immediately.
        Specified by:
        tryRead in class NonBlockingInputStream
        Parameters:
        b - the buffer into which the data is read.
        Returns:
        the total number of bytes read into the buffer or -1 if end of the stream has been reached or 0 in case no data are available to be read at the moment.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • tryRead

        public int tryRead​(byte[] b,
                           int off,
                           int len)
                    throws java.io.IOException
        Description copied from class: NonBlockingInputStream
        Behaves mostly like InputStream.read(byte[], int, int). The main difference is that this method is non-blocking. In case there are no data available to be read, the method returns zero immediately.
        Specified by:
        tryRead in class NonBlockingInputStream
        Parameters:
        b - the buffer into which the data is read.
        off - the start offset in array b at which the data is written.
        len - the maximum number of bytes to read.
        Returns:
        the total number of bytes read into the buffer or -1 if end of the stream has been reached or 0 in case no data are available to be read at the moment.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • notifyDataAvailable

        void notifyDataAvailable​(java.nio.ByteBuffer availableData)
      • close

        public void close()
                   throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class java.io.InputStream
        Throws:
        java.io.IOException
      • notifyError

        void notifyError​(java.lang.Throwable t)
      • notifyAllDataRead

        void notifyAllDataRead()
      • commitToMode

        private void commitToMode()
      • assertAsynchronousOperation

        private void assertAsynchronousOperation()
      • assertSynchronousOperation

        private void assertSynchronousOperation()
      • validateState

        private void validateState()
      • assertClosedForInput

        private void assertClosedForInput()
      • hasDataToRead

        private boolean hasDataToRead()
      • callDataAvailable

        private void callDataAvailable()
      • callOnError

        private void callOnError​(java.lang.Throwable t)
      • callOnAllDataRead

        private void callOnAllDataRead()