bayou.bytes

Class InputStream2ByteSource

java.lang.Object

bayou.bytes.InputStream2ByteSource

All Implemented Interfaces:

ByteSource

public class InputStream2ByteSource
extends Object
implements ByteSource

Converts an InputStream to a ByteSource.

This is useful to use a legacy InputStream in an async, non-blocking app.

CAUTION: creating an InputStream in the first place might be a blocking action; keep that in mind when building a non-blocking app.

Constructor Summary

Constructors

Constructor and Description
InputStream2ByteSource(InputStream inputStream, int bufferSize) Creating a ByteSource based on the InputStream.

Method Summary

Instance Methods
Async<ByteBuffer>	read() Read the next chunk of bytes.
long	skip(long n) Try to skip forward `n` bytes.
Async<Void>	close() Close this source.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bayou.bytes.ByteSource

asString, asString, readAll, toSink

Constructor Detail

InputStream2ByteSource

public InputStream2ByteSource(InputStream inputStream,
                              int bufferSize)

Creating a ByteSource based on the InputStream.

Parameters:

bufferSize - preferred buffer size for read

Method Detail

read

public Async<ByteBuffer> read()
                       throws IllegalStateException

Read the next chunk of bytes.

Specified by:

read in interface ByteSource

Throws:

IllegalStateException - if this source is closed.

skip

public long skip(long n)
          throws IllegalArgumentException,
                 IllegalStateException

Try to skip forward `n` bytes.

Specified by:

skip in interface ByteSource

Parameters:

n - number of bytes to skip; n >= 0.

Returns:

number of bytes (m) actually skipped. 0 <= m <= n.

Throws:

IllegalStateException - if this source is closed.

IllegalArgumentException - if n < 0.

close

public Async<Void> close()

Close this source.

Specified by:

close in interface ByteSource