TimeoutPipedInputStream | Javadocs [I2P+]

java.lang.Object

java.io.InputStream

java.io.PipedInputStream

net.i2p.util.TimeoutPipedInputStream

All Implemented Interfaces:: Closeable, AutoCloseable

class TimeoutPipedInputStreamextends PipedInputStream

Adds setReadTimeout(int). Must be used with a TimeoutPipedOutputStream.

To support InternalSocket.setSoTimeout(int). Package private, not a part of the public API, not for general use.

Field Summary
Fields
Modifier and Type
Field
Description
private boolean
_closedByReader
True once the reading end has closed.
private boolean
_closedByWriter
True once the writing end has closed.
private int
timeout
Milliseconds a read waits for data.
Fields inherited from class PipedInputStream
buffer, in, out, PIPE_SIZE
Constructor Summary
Constructors
Constructor
Description
TimeoutPipedInputStream(int pipeSize)
Creates the pipe with the requested buffer size.
Method Summary
Public Methods
Modifier and Type
Method
Description
void
close()
Overridden to save state.
int
read()
Read the next byte, blocking until available or the timeout is reached.
void
setReadTimeout(int ms)
Must be called before blocking read call.
(package private) void
x_receivedLast()
To save state.
Methods inherited from class PipedInputStream
available, connect, read, receive
Methods inherited from class InputStream
mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- timeout
  private int timeout
  Milliseconds a read waits for data.
- _closedByWriter
  private boolean _closedByWriter
  True once the writing end has closed.
- _closedByReader
  private volatile boolean _closedByReader
  True once the reading end has closed.
Constructor Details
- TimeoutPipedInputStream
  public TimeoutPipedInputStream(int pipeSize)
  Creates the pipe with the requested buffer size.
  Parameters:
  pipeSize - the pipe buffer size in bytes, as passed to the superclass
Method Details
- read
  public int read() throws IOException
  Read the next byte, blocking until available or the timeout is reached.
  Overrides:
  read in class PipedInputStream
  Throws:
  SocketTimeoutException - if timeout is reached
  IOException
- setReadTimeout
  public void setReadTimeout(int ms)
  Must be called before blocking read call.
  Parameters:
  ms - less than or equal to zero means forever
- x_receivedLast
  void x_receivedLast()
  To save state. We have to do this because can't get to closedByWriter in super.
- close
  public void close() throws IOException
  Overridden to save state. We have to do this because can't get to closedByReader in super.
  Specified by:
  close in interface AutoCloseable
  Specified by:
  close in interface Closeable
  Overrides:
  close in class PipedInputStream
  Throws:
  IOException