com.hypirion.io

Class RevivableInputStream

java.lang.Object

java.io.InputStream

com.hypirion.io.RevivableInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class RevivableInputStream
extends java.io.InputStream

A revivable input stream is an unbuffered input stream wrapping another input stream. Its primary feature is that it allows to "kill" blocking .read calls by calling .kill. Reading from the stream can be resumed by calling .resurrect.

The common use for this is to avoid closing an input stream, while still be able to cancel a blocking .read where you must use an input stream. This is useful if you need to send a message to the thread which attempts to read from the input stream.

Since:

com.hypirion.io 0.1.0

Constructor Summary

Constructors

Constructor and Description
RevivableInputStream(java.io.InputStream in) Creates a new RevivableInputStream which wraps in, giving it power to be killed and resurrected.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Returns the number of bytes than can be read from this input stream without blocking.
void	close() Closes this revivable input stream and the underlying input stream, and releases any with system resources (threads, memory) associated with this stream.
void	kill() Kills this revivable input stream.
int	read() Reads the next byte of data from this revivable input stream.
int	read(byte[] b, int off, int len)
void	resurrect() Resurrects a killed revivable input stream.

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

RevivableInputStream

public RevivableInputStream(java.io.InputStream in)

Creates a new RevivableInputStream which wraps in, giving it power to be killed and resurrected.

Method Detail

available

public int available()

Returns the number of bytes than can be read from this input stream without blocking. Will as of now return 0.

Overrides:

available in class java.io.InputStream

Returns:

0

close

public void close()
           throws java.io.IOException

Closes this revivable input stream and the underlying input stream, and releases any with system resources (threads, memory) associated with this stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException - if the underlying InputStream throws an IOException.

read

public int read()
         throws java.io.IOException

Reads the next byte of data from this revivable input stream. The value byte is returned as an int in the range 0 to 255. This method blocks until no data is available, the end of the stream is detected, an exception is thrown or if the reviable input stream is (potentially temporarily) killed.

Specified by:

read in class java.io.InputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached or the stream is killed.

Throws:

java.io.IOException - if the underlying InputStream throws an IOException when attempted to read. This exception will be thrown every time read is called until the stream is closed.

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

kill

public void kill()

Kills this revivable input stream. Makes current and future read calls immediately return -1. The input stream may be revived through resurrect(). If this revivable input stream is already killed, this method does nothing.

See Also:

resurrect()

resurrect

public void resurrect()

Resurrects a killed revivable input stream. This makes it possible to read from this input stream once again. If this revivable input stream is not killed, this method does nothing.

See Also:

kill()