Package org.eclipse.jgit.util.io

Class TimeoutOutputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    public class TimeoutOutputStream
extends java.io.OutputStream
    OutputStream with a configurable timeout.

    • Constructor Summary

      Constructors 
      Constructor Description
      TimeoutOutputStream​(java.io.OutputStream destination, InterruptTimer timer)
      Wrap an output stream with a timeout on all write operations.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()  
      void flush()  
      int getTimeout()  
      void setTimeout​(int millis)  
      void write​(byte[] buf)  
      void write​(byte[] buf, int off, int len)  
      void write​(int b)  

      • Methods inherited from class java.io.OutputStream

        nullOutputStream

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TimeoutOutputStream

        public TimeoutOutputStream​(java.io.OutputStream destination,
                           InterruptTimer timer)
        Wrap an output stream with a timeout on all write operations.
        Parameters:
        destination - base input stream (to write to). The stream must be interruptible (most socket streams are).
        timer - timer to manage the timeouts during writes.

    • Method Detail

      • getTimeout

        public int getTimeout()
        Returns:
        number of milliseconds before aborting a write.

      • setTimeout

        public void setTimeout​(int millis)
        Parameters:
        millis - number of milliseconds before aborting a write. Must be > 0.

      • write

        public void write​(int b)
           throws java.io.IOException
        Specified by:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException

      • write

        public void write​(byte[] buf)
           throws java.io.IOException
        Overrides:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException

      • write

        public void write​(byte[] buf,
                  int off,
                  int len)
           throws java.io.IOException
        Overrides:
        write in class java.io.OutputStream
        Throws:
        java.io.IOException

      • flush

        public void flush()
           throws java.io.IOException
        Specified by:
        flush in interface java.io.Flushable
        Overrides:
        flush in class java.io.OutputStream
        Throws:
        java.io.IOException

      • 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.OutputStream
        Throws:
        java.io.IOException