Package jexer.io

Class TimeoutInputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    public class TimeoutInputStream
extends java.io.InputStream
    This class provides an optional millisecond timeout on its read() operations. This permits callers to bail out rather than block.

    • Constructor Summary

      Constructors 
      Constructor Description
      TimeoutInputStream​(java.io.InputStream stream)
      Public constructor, at the default timeout of 10000 millis (10 seconds).
      TimeoutInputStream​(java.io.InputStream stream, int timeoutMillis)
      Public constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int available()
      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.
      void cancelRead()
      Request that the current read() operation timeout immediately.
      void close()
      Closes this input stream and releases any system resources associated with the stream.
      java.io.InputStream getStream()
      Get the underlying stream.
      void mark​(int readLimit)
      Marks the current position in this input stream.
      boolean markSupported()
      Tests if this input stream supports the mark and reset methods.
      int read()
      Reads the next byte of data from the input stream.
      int read​(byte[] b)
      Reads some number of bytes from the input stream and stores them into the buffer array b.
      int read​(byte[] b, int off, int len)
      Reads up to len bytes of data from the input stream into an array of bytes.
      void reset()
      Repositions this stream to the position at the time the mark method was last called on this input stream.
      long skip​(long n)
      Skips over and discards n bytes of data from this input stream.

      • Methods inherited from class java.io.InputStream

        nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TimeoutInputStream

        public TimeoutInputStream​(java.io.InputStream stream)
        Public constructor, at the default timeout of 10000 millis (10 seconds).
        Parameters:
        stream - the wrapped InputStream

      • TimeoutInputStream

        public TimeoutInputStream​(java.io.InputStream stream,
                          int timeoutMillis)
        Public constructor.
        Parameters:
        stream - the wrapped InputStream
        timeoutMillis - the timeout value in millis. If it takes longer than this for bytes to be available for read then a ReadTimeoutException is thrown. A value of 0 means to block as a normal InputStream would.

    • Method Detail

      • read

        public int read()
         throws java.io.IOException
        Reads the next byte of data from the input stream.
        Specified by:
        read in class java.io.InputStream
        Returns:
        the next byte of data, or -1 if there is no more data because the end of the stream has been reached.
        Throws:
        java.io.IOException - if an I/O error occurs

      • read

        public int read​(byte[] b)
         throws java.io.IOException
        Reads some number of bytes from the input stream and stores them into the buffer array b.
        Overrides:
        read in class java.io.InputStream
        Parameters:
        b - the buffer into which the data is read.
        Returns:
        the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
        Throws:
        java.io.IOException - if an I/O error occurs

      • read

        public int read​(byte[] b,
                int off,
                int len)
         throws java.io.IOException
        Reads up to len bytes of data from the input stream into an array of bytes.
        Overrides:
        read in class java.io.InputStream
        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 there is no more data because the end of the stream has been reached.
        Throws:
        java.io.IOException - if an I/O error occurs

      • available

        public int available()
              throws java.io.IOException
        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.
        Overrides:
        available in class java.io.InputStream
        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.
        Throws:
        java.io.IOException - if an I/O error occurs

      • close

        public void close()
           throws java.io.IOException
        Closes this input stream and releases any system resources associated with the stream.
        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 - if an I/O error occurs

      • mark

        public void mark​(int readLimit)
        Marks the current position in this input stream.
        Overrides:
        mark in class java.io.InputStream
        Parameters:
        readLimit - the maximum limit of bytes that can be read before the mark position becomes invalid

      • markSupported

        public boolean markSupported()
        Tests if this input stream supports the mark and reset methods.
        Overrides:
        markSupported in class java.io.InputStream
        Returns:
        true if this stream instance supports the mark and reset methods; false otherwise

      • reset

        public void reset()
           throws java.io.IOException
        Repositions this stream to the position at the time the mark method was last called on this input stream.
        Overrides:
        reset in class java.io.InputStream
        Throws:
        java.io.IOException - if an I/O error occurs

      • skip

        public long skip​(long n)
          throws java.io.IOException
        Skips over and discards n bytes of data from this input stream.
        Overrides:
        skip in class java.io.InputStream
        Parameters:
        n - the number of bytes to be skipped
        Returns:
        the actual number of bytes skipped
        Throws:
        java.io.IOException - if an I/O error occurs

      • cancelRead

        public void cancelRead()
        Request that the current read() operation timeout immediately.

      • getStream

        public java.io.InputStream getStream()
        Get the underlying stream.
        Returns:
        the stream