Package org.dellroad.stuff.io

Class NullModemInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.dellroad.stuff.io.NullModemInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class NullModemInputStream
extends FilterInputStream

Presents an InputStream interface given a WriteCallback that can write to an OutputStream.

A background process, initated by a provided Executor, invokes the WriteCallback to write to an OutputStream that relays whatever is written to this InputStream.

Exceptions

Regarding this InputStream:

• If the WriteCallback throws an IOException, any subsequent read from this InputStream will throw an IOException, with the original appended to it.

Regarding the OutputStream provided to the WriteCallback:

• If this InputStream is close()'ed, any subsequent write to the OutputStream by the WriteCallback will generate an IOException.

Since:

1.0.74

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
NullModemInputStream(WriteCallback writer, String threadName)	Constructor that uses a background thread for writing.
NullModemInputStream(WriteCallback writer, Executor executor)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	available()
protected PipedStreams	getPipedStreams()	Get the PipedStreams associated with this instance.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.FilterInputStream

close, mark, markSupported

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

NullModemInputStream

public NullModemInputStream(WriteCallback writer,
 String threadName)

Constructor that uses a background thread for writing.

Delegates to NullModemInputStream(WriteCallback, Executor), passing an executor that creates a dedicated daemon Thread with the given name.

Parameters:

writer - callback that writes the data to be read

threadName - name for the background thread to be created

NullModemInputStream

public NullModemInputStream(WriteCallback writer,
 Executor executor)

Constructor.

The writer's writeTo() method will be invoked (once) asynchronously in a dedicated writer thread. This instance will produce whatever data is written by writer to the provided OutputStream.

Parameters:

writer - callback that writes the data to be read

executor - executes writing process in the background

Throws:

IllegalArgumentException - if any parameter is null

Method Details

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class FilterInputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

getPipedStreams

protected PipedStreams getPipedStreams()

Get the PipedStreams associated with this instance.

Returns:

the underlying PipedStreams