Module

Package org.xnio.conduits

Class BufferedStreamSourceConduit

java.lang.Object

org.xnio.conduits.AbstractConduit<D>

org.xnio.conduits.AbstractSourceConduit<D>

org.xnio.conduits.AbstractStreamSourceConduit<StreamSourceConduit>

org.xnio.conduits.BufferedStreamSourceConduit

All Implemented Interfaces:

Conduit, SourceConduit, StreamSourceConduit

public final class BufferedStreamSourceConduit
extends AbstractStreamSourceConduit<StreamSourceConduit>

A stream source conduit which buffers input.

Author:

David M. Lloyd

Field Summary

Fields inherited from class org.xnio.conduits.AbstractConduit

next

Constructor Summary

Constructors

Constructor	Description
BufferedStreamSourceConduit(StreamSourceConduit next, Pooled<java.nio.ByteBuffer> pooledBuffer)	Construct a new instance.

Method Summary

Modifier and Type	Method	Description
int	read(java.nio.ByteBuffer dst)	Read a sequence of bytes from this conduit to the given buffer.
long	read(java.nio.ByteBuffer[] dsts, int offs, int len)	Read a sequence of bytes from this conduit to the given buffers.
void	terminateReads()	Indicate that no more data will be read from this conduit.
long	transferTo(long position, long count, java.nio.channels.FileChannel target)	Transfers bytes into the given file from this channel.
long	transferTo(long count, java.nio.ByteBuffer throughBuffer, StreamSinkChannel target)	Transfers bytes into the given channel target.

Methods inherited from class org.xnio.conduits.AbstractSourceConduit

awaitReadable, awaitReadable, getReadThread, isReadResumed, isReadShutdown, resumeReads, setReadReadyHandler, suspendReads, wakeupReads

Methods inherited from class org.xnio.conduits.AbstractConduit

getWorker

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xnio.conduits.Conduit

getWorker

Methods inherited from interface org.xnio.conduits.SourceConduit

awaitReadable, awaitReadable, getReadThread, isReadResumed, isReadShutdown, resumeReads, setReadReadyHandler, suspendReads, wakeupReads

Constructor Detail

BufferedStreamSourceConduit

public BufferedStreamSourceConduit(StreamSourceConduit next,
                                   Pooled<java.nio.ByteBuffer> pooledBuffer)

Construct a new instance.

Parameters:

next - the delegate conduit to set

pooledBuffer - the buffer to use

Method Detail

transferTo

public long transferTo(long position,
                       long count,
                       java.nio.channels.FileChannel target)
                throws java.io.IOException

Description copied from interface: StreamSourceConduit

Transfers bytes into the given file from this channel.

Specified by:

transferTo in interface StreamSourceConduit

Overrides:

transferTo in class AbstractStreamSourceConduit<StreamSourceConduit>

Parameters:

position - the position within the file from which the transfer is to begin

count - the number of bytes to be transferred

target - the file to write to

Returns:

the number of bytes (possibly 0) that were actually transferred

Throws:

java.io.IOException - if an I/O error occurs

transferTo

public long transferTo(long count,
                       java.nio.ByteBuffer throughBuffer,
                       StreamSinkChannel target)
                throws java.io.IOException

Description copied from interface: StreamSourceConduit

Transfers bytes into the given channel target. On entry, throughBuffer will be cleared. On exit, the buffer will be flipped for emptying, and may possibly be empty or may contain data. If this method returns a value less than count, then the remaining data in throughBuffer may contain data read from this channel which must be written to target to complete the operation.

Specified by:

transferTo in interface StreamSourceConduit

Overrides:

transferTo in class AbstractStreamSourceConduit<StreamSourceConduit>

Parameters:

count - the number of bytes to be transferred

throughBuffer - the buffer to copy through.

target - the destination to write to

Returns:

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached

Throws:

java.io.IOException - if an I/O error occurs

read

public int read(java.nio.ByteBuffer dst)
         throws java.io.IOException

Description copied from interface: StreamSourceConduit

Read a sequence of bytes from this conduit to the given buffer.

Specified by:

read in interface StreamSourceConduit

Overrides:

read in class AbstractStreamSourceConduit<StreamSourceConduit>

Returns:

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached or this conduit's SourceConduit.terminateReads() method was previously called

Throws:

java.io.IOException - if an error occurs

read

public long read(java.nio.ByteBuffer[] dsts,
                 int offs,
                 int len)
          throws java.io.IOException

Description copied from interface: StreamSourceConduit

Read a sequence of bytes from this conduit to the given buffers.

Specified by:

read in interface StreamSourceConduit

Overrides:

read in class AbstractStreamSourceConduit<StreamSourceConduit>

offs - the offset into the buffer array

len - the number of buffers to fill

Returns:

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached or this conduit's SourceConduit.terminateReads() method was previously called

Throws:

java.io.IOException - if an error occurs

terminateReads

public void terminateReads()
                    throws java.io.IOException

Description copied from interface: SourceConduit

Indicate that no more data will be read from this conduit. If unread data exists, an exception may be thrown.

Specified by:

terminateReads in interface SourceConduit

Overrides:

terminateReads in class AbstractSourceConduit<StreamSourceConduit>

Throws:

java.io.IOException - if there was a problem