org.xnio.conduits

Interface StreamSourceConduit

All Superinterfaces:

Conduit, SourceConduit

All Known Implementing Classes:

AbstractStreamSourceConduit, AjpServerRequestConduit, BlockingStreamSourceConduit, BrokenStreamSourceConduit, BufferedStreamSourceConduit, BytesReceivedStreamSourceConduit, ChunkedStreamSourceConduit, DebuggingStreamSourceConduit, EmptyStreamSourceConduit, EmptyStreamSourceConduit, FinishableStreamSourceConduit, FixedLengthStreamSourceConduit, FixedLengthStreamSourceConduit, GzipStreamSourceConduit, IdleTimeoutConduit, InflatingStreamSourceConduit, InflatingStreamSourceConduit, MessageStreamSourceConduit, PushBackStreamSourceConduit, ReadDataStreamSourceConduit, ReadTimeoutStreamSourceConduit, SslConduit, StreamSourceChannelWrappingConduit, SynchronizedStreamSourceConduit

public interface StreamSourceConduit
extends SourceConduit

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
int	read(ByteBuffer dst) Read a sequence of bytes from this conduit to the given buffer.
long	read(ByteBuffer[] dsts, int offs, int len) Read a sequence of bytes from this conduit to the given buffers.
long	transferTo(long count, ByteBuffer throughBuffer, StreamSinkChannel target) Transfers bytes into the given channel target.
long	transferTo(long position, long count, FileChannel target) Transfers bytes into the given file from this channel.

Methods inherited from interface org.xnio.conduits.SourceConduit

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

Methods inherited from interface org.xnio.conduits.Conduit

getWorker

Method Detail

transferTo

long transferTo(long position,
                long count,
                FileChannel target)
         throws IOException

Transfers bytes into the given file from this channel.

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:

IOException - if an I/O error occurs

transferTo

long transferTo(long count,
                ByteBuffer throughBuffer,
                StreamSinkChannel target)
         throws IOException

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.

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:

IOException - if an I/O error occurs

read

int read(ByteBuffer dst)
  throws IOException

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

Parameters:

src - the buffer to fill with data from the conduit

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:

IOException - if an error occurs

read

long read(ByteBuffer[] dsts,
          int offs,
          int len)
   throws IOException

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

Parameters:

srcs - the buffers to fill with data from the conduit

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:

IOException - if an error occurs