Modifier and Type	Class and Description
public static interface	BufferPipeInputStream.InputHandler A handler for events relating to the consumption of data from a `BufferPipeInputStream` instance.

Modifier and Type	Field and Description
private boolean	eof
private IOException	failure
private final BufferPipeInputStream.InputHandler	inputHandler
private final Queue<Pooled<ByteBuffer>>	queue

Access	Constructor and Description
public	BufferPipeInputStream(final BufferPipeInputStream.InputHandler the input events handler inputHandler) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
private void	checkFailure()
private void	clearQueue()
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public void	push(final ByteBuffer the buffer from which more data should be read buffer) Push a buffer into the queue.
public void	push(final Pooled<ByteBuffer> the buffer from which more data should be read pooledBuffer) References Deprecated `Pooled` is deprecated or references (maybe indirectly) at least one deprecated element. Push a buffer into the queue.
public void	pushEof() Push the EOF condition into the queue.
public void	pushException(IOException the exception to push e) Push an exception condition into the queue.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(final byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public long	skip(long the number of bytes to be skipped. qty) Overrides java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream.

Inherited from java.io.InputStream:: mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skipNBytes transferTo

Field Detail

eof	back to summary
private boolean eof

failure	back to summary
private IOException failure

inputHandler	back to summary
private final BufferPipeInputStream.InputHandler inputHandler

queue	back to summary
private final Queue<Pooled<ByteBuffer>> queue

Constructor Detail

BufferPipeInputStream back to summary

BufferPipeInputStream	back to summary
public BufferPipeInputStream(final BufferPipeInputStream.InputHandler inputHandler) Construct a new instance. The given `inputHandler` will be invoked after each buffer is fully read and when the stream is closed. Parameters inputHandler:BufferPipeInputStream.InputHandler the input events handler

public BufferPipeInputStream(final BufferPipeInputStream.InputHandler inputHandler)

Construct a new instance. The given inputHandler will be invoked after each buffer is fully read and when the stream is closed.

Parameters

inputHandler:BufferPipeInputStream.InputHandler: the input events handler

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Exceptions

IOException:: if an I/O error occurs.

checkFailure	back to summary
private void checkFailure() throws IOException

clearQueue	back to summary
private void clearQueue()

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Exceptions

IOException:: if an I/O error occurs.

push back to summary

push	back to summary
public void push(final ByteBuffer buffer) Push a buffer into the queue. There is no mechanism to limit the number of pushed buffers; if such a mechanism is desired, it must be implemented externally, for example maybe using a `Semaphore`. Parameters buffer:ByteBuffer the buffer from which more data should be read

public void push(final ByteBuffer buffer)

Push a buffer into the queue. There is no mechanism to limit the number of pushed buffers; if such a mechanism is desired, it must be implemented externally, for example maybe using a Semaphore.

Parameters

buffer:ByteBuffer: the buffer from which more data should be read

push back to summary

push	back to summary
public void push(final Pooled<ByteBuffer> pooledBuffer) References Deprecated `Pooled` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Push a buffer into the queue. There is no mechanism to limit the number of pushed buffers; if such a mechanism is desired, it must be implemented externally, for example maybe using a `Semaphore`. Parameters pooledBuffer:Pooled<ByteBuffer> the buffer from which more data should be read

public void push(final Pooled<ByteBuffer> pooledBuffer)

References Deprecated

Pooled is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Push a buffer into the queue. There is no mechanism to limit the number of pushed buffers; if such a mechanism is desired, it must be implemented externally, for example maybe using a Semaphore.

Parameters

pooledBuffer:Pooled<ByteBuffer>: the buffer from which more data should be read

pushEof	back to summary
public void pushEof() Push the EOF condition into the queue. After this method is called, no further buffers may be pushed into this instance.

pushException	back to summary
public void pushException(IOException e) Push an exception condition into the queue. After this method is called, no further buffers may be pushed into this instance. Parameters e:IOException the exception to push

pushException

back to summary

public void pushException(IOException e)

Push an exception condition into the queue. After this method is called, no further buffers may be pushed into this instance.

Parameters

e:IOException: the exception to push

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

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

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(final byte[] b, int off, int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

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

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

skip back to summary

skip	back to summary
public long skip(long qty) throws IOException Overrides java.io.InputStream.skip. Doc from java.io.InputStream.skip. Skips over and discards `n` bytes of data from this input stream. The `skip` method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly `0`. This may result from any of a number of conditions; reaching end of file before `n` bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If `n` is negative, the `skip` method for class `InputStream` always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently. Parameters qty:long the number of bytes to be skipped. Returns:long the actual number of bytes skipped which might be zero. Exceptions IOException: if an I/O error occurs.

public long skip(long qty) throws IOException

Overrides java.io.InputStream.skip.

Doc from java.io.InputStream.skip.

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, the skip method for class InputStream always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

Parameters

qty:long: the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped which might be zero.

Exceptions

IOException:: if an I/O error occurs.

org.xnio.streams back to summary

public Interface BufferPipeInputStream.InputHandler

extends Closeable

A handler for events relating to the consumption of data from a BufferPipeInputStream instance.

Method Summary

Modifier and Type	Method and Description
public void	acknowledge(Pooled<ByteBuffer> the pooled resource which was consumed pooled) References Deprecated `Pooled` is deprecated or references (maybe indirectly) at least one deprecated element. Acknowledges the successful processing of an input buffer.
public void	close() Redeclares java.io.Closeable.close. Signifies that the user of the enclosing `BufferPipeInputStream` has called the `close()` method explicitly.

Method Detail

acknowledge back to summary

acknowledge	back to summary
public void acknowledge(Pooled<ByteBuffer> pooled) throws IOException References Deprecated `Pooled` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Acknowledges the successful processing of an input buffer. Though this method may throw an exception, it is not acted upon. The acknowledged resource is passed in, with its position set to the number of bytes consumed. Parameters pooled:Pooled<ByteBuffer> the pooled resource which was consumed Exceptions IOException: if an I/O error occurs sending the acknowledgement

public void acknowledge(Pooled<ByteBuffer> pooled) throws IOException

References Deprecated

Pooled is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Acknowledges the successful processing of an input buffer. Though this method may throw an exception, it is not acted upon. The acknowledged resource is passed in, with its position set to the number of bytes consumed.

Parameters

pooled:Pooled<ByteBuffer>: the pooled resource which was consumed

Exceptions

IOException:: if an I/O error occurs sending the acknowledgement

close back to summary

close	back to summary
public void close() throws IOException Redeclares java.io.Closeable.close. Signifies that the user of the enclosing `BufferPipeInputStream` has called the `close()` method explicitly. Any thrown exception is propagated up to the caller of `NioByteInput.close()`. Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Redeclares java.io.Closeable.close.

Signifies that the user of the enclosing BufferPipeInputStream has called the close() method explicitly. Any thrown exception is propagated up to the caller of NioByteInput.close().

Exceptions

IOException:: if an I/O error occurs

public Class BufferPipeInputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface BufferPipeInputStream.InputHandler

Method Summary

Method Detail