Package org.xnio.conduits
Class FixedLengthStreamSinkConduit
java.lang.Object
org.xnio.conduits.AbstractConduit<D>
org.xnio.conduits.AbstractSinkConduit<D>
org.xnio.conduits.AbstractStreamSinkConduit<StreamSinkConduit>
org.xnio.conduits.FixedLengthStreamSinkConduit
- All Implemented Interfaces:
Conduit
,SinkConduit
,StreamSinkConduit
public final class FixedLengthStreamSinkConduit
extends AbstractStreamSinkConduit<StreamSinkConduit>
implements StreamSinkConduit
A stream sink conduit with a limited length.
- Author:
- David M. Lloyd
-
Field Summary
Fields inherited from class org.xnio.conduits.AbstractConduit
next
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct a new instance. -
Method Summary
Modifier and TypeMethodDescriptionlong
Get the number of remaining bytes available to read.void
Signal that no more write data is forthcoming.long
transferFrom
(FileChannel src, long position, long count) Transfer bytes into this conduit from the given file.long
transferFrom
(StreamSourceChannel source, long count, ByteBuffer throughBuffer) Transfers bytes from the given channel source.void
Terminate writes and discard any outstanding write data.int
write
(ByteBuffer src) Writes a sequence of bytes to this conduit from the given buffer.long
write
(ByteBuffer[] srcs, int offs, int len) Writes a sequence of bytes to this conduit from the given buffers.int
writeFinal
(ByteBuffer src) Writes some data to the conduit, with the same semantics asStreamSinkConduit.write(java.nio.ByteBuffer)
.long
writeFinal
(ByteBuffer[] srcs, int offset, int length) Writes some data to the conduit, with the same semantics asStreamSinkConduit.write(java.nio.ByteBuffer[], int, int)
.Methods inherited from class org.xnio.conduits.AbstractSinkConduit
awaitWritable, awaitWritable, flush, getWriteThread, isWriteResumed, isWriteShutdown, resumeWrites, setWriteReadyHandler, suspendWrites, wakeupWrites
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.SinkConduit
awaitWritable, awaitWritable, flush, getWriteThread, isWriteResumed, isWriteShutdown, resumeWrites, setWriteReadyHandler, suspendWrites, wakeupWrites
-
Constructor Details
-
FixedLengthStreamSinkConduit
Construct a new instance.- Parameters:
next
- the delegate conduit to set
-
-
Method Details
-
transferFrom
Description copied from interface:StreamSinkConduit
Transfer bytes into this conduit from the given file.- Specified by:
transferFrom
in interfaceStreamSinkConduit
- Overrides:
transferFrom
in classAbstractStreamSinkConduit<StreamSinkConduit>
- Parameters:
src
- the file to read fromposition
- the position within the file from which the transfer is to begincount
- the number of bytes to be transferred- Returns:
- the number of bytes (possibly 0) that were actually transferred
- Throws:
IOException
- if an I/O error occurs
-
transferFrom
public long transferFrom(StreamSourceChannel source, long count, ByteBuffer throughBuffer) throws IOException Description copied from interface:StreamSinkConduit
Transfers bytes from the given channel source. On entry,throughBuffer
will be cleared. On exit, the buffer will be flipped for emptying, and may be empty or may contain data. If this method returns a value less thancount
, then the remaining data inthroughBuffer
may contain data read fromsource
which must be written to this channel to complete the operation.- Specified by:
transferFrom
in interfaceStreamSinkConduit
- Overrides:
transferFrom
in classAbstractStreamSinkConduit<StreamSinkConduit>
- Parameters:
source
- the source to read fromcount
- the number of bytes to be transferredthroughBuffer
- the buffer to copy through.- 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
-
writeFinal
Description copied from interface:StreamSinkConduit
Writes some data to the conduit, with the same semantics asStreamSinkConduit.write(java.nio.ByteBuffer)
. If all the data is written out then the conduit will have its writes terminated. Semantically this method is equivalent to:int rem = src.remaining(); int written = conduit.write(src); if(written == rem) { conduit.terminateWrites() }
- Specified by:
writeFinal
in interfaceStreamSinkConduit
- Overrides:
writeFinal
in classAbstractStreamSinkConduit<StreamSinkConduit>
- Parameters:
src
- The data to write- Returns:
- The amount of data that was actually written.
- Throws:
IOException
-
writeFinal
Description copied from interface:StreamSinkConduit
Writes some data to the conduit, with the same semantics asStreamSinkConduit.write(java.nio.ByteBuffer[], int, int)
. If all the data is written out then the conduit will have its writes terminated.- Specified by:
writeFinal
in interfaceStreamSinkConduit
- Overrides:
writeFinal
in classAbstractStreamSinkConduit<StreamSinkConduit>
- Parameters:
srcs
- The buffers from which bytes are to be retrievedoffset
- The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.lengthlength
- The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset- Returns:
- The amount of data that was actually written
- Throws:
IOException
-
write
Description copied from interface:StreamSinkConduit
Writes a sequence of bytes to this conduit from the given buffer.- Specified by:
write
in interfaceStreamSinkConduit
- Overrides:
write
in classAbstractStreamSinkConduit<StreamSinkConduit>
- Parameters:
src
- the buffer containing data to write- Returns:
- the number of bytes written, possibly 0
- Throws:
ClosedChannelException
- if this conduit'sSinkConduit.terminateWrites()
method was previously calledIOException
- if an error occurs
-
write
Description copied from interface:StreamSinkConduit
Writes a sequence of bytes to this conduit from the given buffers.- Specified by:
write
in interfaceStreamSinkConduit
- Overrides:
write
in classAbstractStreamSinkConduit<StreamSinkConduit>
- Parameters:
srcs
- the buffers containing data to writeoffs
- the offset into the buffer arraylen
- the number of buffers to write- Returns:
- the number of bytes written, possibly 0
- Throws:
ClosedChannelException
- if this conduit'sSinkConduit.terminateWrites()
method was previously calledIOException
- if an error occurs
-
terminateWrites
Description copied from interface:SinkConduit
Signal that no more write data is forthcoming. The conduit must beSinkConduit.flush()
ed before it is considered to be shut down.- Specified by:
terminateWrites
in interfaceSinkConduit
- Overrides:
terminateWrites
in classAbstractSinkConduit<StreamSinkConduit>
- Throws:
IOException
-
truncateWrites
Description copied from interface:SinkConduit
Terminate writes and discard any outstanding write data. The conduit is terminated and flushed regardless of the outcome of this method.- Specified by:
truncateWrites
in interfaceSinkConduit
- Overrides:
truncateWrites
in classAbstractSinkConduit<StreamSinkConduit>
- Throws:
IOException
- if channel termination failed for some reason
-
getRemaining
public long getRemaining()Get the number of remaining bytes available to read.- Returns:
- the number of remaining bytes available to read
-