org.xnio.conduits.FixedLengthStreamSourceConduit

All Implemented Interfaces:: Conduit, SourceConduit, StreamSourceConduit

public final class FixedLengthStreamSourceConduit extends AbstractStreamSourceConduit<StreamSourceConduit> implements StreamSourceConduit

A stream source conduit which limits the length of input.

Author:: David M. Lloyd

Field Summary

Fields inherited from class org.xnio.conduits.AbstractConduit
next
Constructor Summary

Constructors

Constructor

Description

FixedLengthStreamSourceConduit(StreamSourceConduit next, long remaining)

Construct a new instance.
Method Summary

Modifier and Type

Method

Description

long

getRemaining()

Get the number of bytes which remain available to read.

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 position, long count, FileChannel target)

Transfers bytes into the given file from this channel.

long

transferTo(long count, 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, terminateReads, 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, terminateReads, wakeupReads

Constructor Details
- FixedLengthStreamSourceConduit
  
  public FixedLengthStreamSourceConduit(StreamSourceConduit next, long remaining)
  
  Construct a new instance.
  
  Parameters:
  
  next - the conduit to limit
  
  remaining - the number of bytes to limit to
Method Details
- transferTo
  
  public long transferTo(long position, long count, FileChannel target) throws 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:
  
  IOException - if an I/O error occurs
- transferTo
  
  public long transferTo(long count, ByteBuffer throughBuffer, StreamSinkChannel target) throws 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:
  
  IOException - if an I/O error occurs
- read
  
  public int read(ByteBuffer dst) throws 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:
  
  IOException - if an error occurs
- read
  
  public long read(ByteBuffer[] dsts, int offs, int len) throws 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:
  
  IOException - if an error occurs
- getRemaining
  
  public long getRemaining()
  
  Get the number of bytes which remain available to read.
  
  Returns:
  
  the number of bytes which remain available to read

Class FixedLengthStreamSourceConduit

Field Summary

Fields inherited from class org.xnio.conduits.AbstractConduit

Constructor Summary

Method Summary

Methods inherited from class org.xnio.conduits.AbstractSourceConduit

Methods inherited from class org.xnio.conduits.AbstractConduit

Methods inherited from class java.lang.Object

Methods inherited from interface org.xnio.conduits.Conduit

Methods inherited from interface org.xnio.conduits.SourceConduit

Constructor Details

FixedLengthStreamSourceConduit

Method Details

transferTo

transferTo

read

read

getRemaining