- All Superinterfaces:
AutoCloseable
,Channel
,Closeable
,CloseableChannel
,Configurable
,GatheringByteChannel
,InterruptibleChannel
,SuspendableWriteChannel
,WritableByteChannel
- All Known Subinterfaces:
ConnectedSslStreamChannel
,ConnectedStreamChannel
,StreamChannel
- All Known Implementing Classes:
AssembledConnectedSslStreamChannel
,AssembledConnectedStreamChannel
,AssembledStreamChannel
,ConduitStreamSinkChannel
,FixedLengthStreamSinkChannel
,NullStreamSinkChannel
,SplitStreamSinkChannel
public interface StreamSinkChannel
extends WritableByteChannel, GatheringByteChannel, SuspendableWriteChannel
A stream sink channel. This type of channel is a writable destination for bytes. While all channel types are
thread-safe, writing a stream from more than one thread concurrently will cause data corruption and may be
disallowed at the option of the implementation.
-
Field Summary
Fields inherited from interface org.xnio.channels.Configurable
EMPTY
-
Method Summary
Modifier and TypeMethodDescriptionChannelListener.Setter<? extends StreamSinkChannel>
Get the setter which can be used to change the close listener for this channel.ChannelListener.Setter<? extends StreamSinkChannel>
Get the setter which can be used to change the write listener for this channel.long
transferFrom
(FileChannel src, long position, long count) Transfer bytes into this channel from the given file.long
transferFrom
(StreamSourceChannel source, long count, ByteBuffer throughBuffer) Transfers bytes from the given channel source.int
writeFinal
(ByteBuffer src) Writes some data to the channel, with the same semantics asWritableByteChannel.write(java.nio.ByteBuffer)
.long
writeFinal
(ByteBuffer[] srcs) Writes some data to the channel, with the same semantics asGatheringByteChannel.write(java.nio.ByteBuffer[])
.long
writeFinal
(ByteBuffer[] srcs, int offset, int length) Writes some data to the channel, with the same semantics asGatheringByteChannel.write(java.nio.ByteBuffer[], int, int)
.Methods inherited from interface org.xnio.channels.CloseableChannel
getIoThread, getWorker
Methods inherited from interface org.xnio.channels.Configurable
getOption, setOption, supportsOption
Methods inherited from interface java.nio.channels.GatheringByteChannel
write, write
Methods inherited from interface org.xnio.channels.SuspendableWriteChannel
awaitWritable, awaitWritable, close, flush, getWriteThread, isOpen, isWriteResumed, resumeWrites, shutdownWrites, suspendWrites, wakeupWrites
Methods inherited from interface java.nio.channels.WritableByteChannel
write
-
Method Details
-
transferFrom
Transfer bytes into this channel from the given file. Using this method in preference toFileChannel.transferTo(long, long, WritableByteChannel)
may provide a performance advantage on some platforms.If the current thread is interrupted when this method is called, it may throw a
InterruptedIOException
; however, if this exception is thrown, theInterruptedIOException.bytesTransferred
field is guaranteed to be 0.- 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
long transferFrom(StreamSourceChannel source, long count, ByteBuffer throughBuffer) throws IOException Transfers bytes from the given channel source. On some platforms, this may avoid copying bytes between user and kernel space. On other platforms, bytes are passed through thethroughBuffer
parameter's buffer space. 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. Note that using a direct buffer may provide an intermediate performance gain on platforms without zero-copy facilities.If the current thread is interrupted when this method is called, it may throw a
InterruptedIOException
; however, if this exception is thrown, theInterruptedIOException.bytesTransferred
field is guaranteed to be 0.- 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
-
getWriteSetter
ChannelListener.Setter<? extends StreamSinkChannel> getWriteSetter()Get the setter which can be used to change the write listener for this channel.- Specified by:
getWriteSetter
in interfaceSuspendableWriteChannel
- Returns:
- the setter
-
getCloseSetter
ChannelListener.Setter<? extends StreamSinkChannel> getCloseSetter()Get the setter which can be used to change the close listener for this channel. If the channel is already closed, then the listener will not be called.- Specified by:
getCloseSetter
in interfaceCloseableChannel
- Specified by:
getCloseSetter
in interfaceSuspendableWriteChannel
- Returns:
- the setter
-
writeFinal
Writes some data to the channel, with the same semantics asWritableByteChannel.write(java.nio.ByteBuffer)
. If all the data is written out then the channel will have its writes shutdown. Semantically this method is equivalent to:int rem = src.remaining(); int written = channel.write(src); if(written == rem) { channel.shutdownWrites() }
If an exception is thrown the caller is still responsible for closing the channel.- Parameters:
src
- The data to write- Returns:
- The amount of data that was actually written.
- Throws:
IOException
- See Also:
-
writeFinal
Writes some data to the channel, with the same semantics asGatheringByteChannel.write(java.nio.ByteBuffer[], int, int)
. If all the data is written out then the channel will have its writes shutdown. If an exception is thrown the caller is still responsible for closing the channel.- 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
- See Also:
-
writeFinal
Writes some data to the channel, with the same semantics asGatheringByteChannel.write(java.nio.ByteBuffer[])
. If all the data is written out then the channel will have its writes shutdown. If an exception is thrown the caller is still responsible for closing the channel.- Parameters:
srcs
- The buffers from which bytes are to be retrieved- Returns:
- The amount of data that was actually written
- Throws:
IOException
- See Also:
-