- java.lang.Object
-
- org.xnio.conduits.ConduitStreamSinkChannel
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,java.lang.Cloneable
,java.nio.channels.Channel
,java.nio.channels.GatheringByteChannel
,java.nio.channels.InterruptibleChannel
,java.nio.channels.WritableByteChannel
,CloseableChannel
,CloseListenerSettable<ConduitStreamSinkChannel>
,Configurable
,StreamSinkChannel
,SuspendableWriteChannel
,WriteListenerSettable<ConduitStreamSinkChannel>
public final class ConduitStreamSinkChannel extends java.lang.Object implements StreamSinkChannel, WriteListenerSettable<ConduitStreamSinkChannel>, CloseListenerSettable<ConduitStreamSinkChannel>, java.lang.Cloneable
A stream sink channel which wraps a stream sink conduit.- Author:
- David M. Lloyd
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.xnio.channels.CloseListenerSettable
CloseListenerSettable.Setter<C extends java.nio.channels.Channel>
-
Nested classes/interfaces inherited from interface org.xnio.channels.WriteListenerSettable
WriteListenerSettable.Setter<C extends java.nio.channels.Channel>
-
-
Field Summary
-
Fields inherited from interface org.xnio.channels.Configurable
EMPTY
-
-
Constructor Summary
Constructors Constructor Description ConduitStreamSinkChannel(Configurable configurable, StreamSinkConduit conduit)
Construct a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
awaitWritable()
Block until this channel becomes writable again.void
awaitWritable(long time, java.util.concurrent.TimeUnit timeUnit)
Block until this channel becomes writable again, or until the timeout expires.ConduitStreamSinkChannel
clone()
Duplicate this channel.void
close()
Close this channel.boolean
flush()
Flush any waiting partial send or write.ChannelListener<? super ConduitStreamSinkChannel>
getCloseListener()
Get the close listener.ChannelListener.Setter<ConduitStreamSinkChannel>
getCloseSetter()
Get the setter which can be used to change the close listener for this channel.StreamSinkConduit
getConduit()
Get the underlying conduit for this channel.XnioIoThread
getIoThread()
Get the I/O thread associated with this channel.<T> T
getOption(Option<T> option)
Get the value of a channel option.XnioWorker
getWorker()
Get the worker for this channel.ChannelListener<? super ConduitStreamSinkChannel>
getWriteListener()
Get the write listener.ChannelListener.Setter<ConduitStreamSinkChannel>
getWriteSetter()
Get the setter which can be used to change the write listener for this channel.XnioExecutor
getWriteThread()
Deprecated.boolean
isOpen()
Determine whether this channel is open.boolean
isWriteResumed()
Determine whether writes are resumed.void
resumeWrites()
Resume writes on this channel.void
setCloseListener(ChannelListener<? super ConduitStreamSinkChannel> closeListener)
Set the close listener.void
setConduit(StreamSinkConduit conduit)
Set the underlying conduit for this channel.<T> T
setOption(Option<T> option, T value)
Set an option for this channel.void
setWriteListener(ChannelListener<? super ConduitStreamSinkChannel> writeListener)
Set the write listener.void
shutdownWrites()
Indicate that writing is complete for this channel.boolean
supportsOption(Option<?> option)
Determine whether an option is supported on this channel.void
suspendWrites()
Suspend further write notifications on this channel.java.lang.String
toString()
long
transferFrom(java.nio.channels.FileChannel src, long position, long count)
Transfer bytes into this channel from the given file.long
transferFrom(StreamSourceChannel source, long count, java.nio.ByteBuffer throughBuffer)
Transfers bytes from the given channel source.void
wakeupWrites()
Resume writes
on this channel, and force the write listener to be triggered even if the channel isn't actually writable.int
write(java.nio.ByteBuffer dst)
long
write(java.nio.ByteBuffer[] srcs)
long
write(java.nio.ByteBuffer[] dsts, int offs, int len)
int
writeFinal(java.nio.ByteBuffer src)
Writes some data to the channel, with the same semantics asWritableByteChannel.write(java.nio.ByteBuffer)
.long
writeFinal(java.nio.ByteBuffer[] srcs)
Writes some data to the channel, with the same semantics asGatheringByteChannel.write(java.nio.ByteBuffer[])
.long
writeFinal(java.nio.ByteBuffer[] srcs, int offset, int length)
Writes some data to the channel, with the same semantics asGatheringByteChannel.write(java.nio.ByteBuffer[], int, int)
.
-
-
-
Constructor Detail
-
ConduitStreamSinkChannel
public ConduitStreamSinkChannel(Configurable configurable, StreamSinkConduit conduit)
Construct a new instance.- Parameters:
configurable
- the configurable to delegate configuration requests toconduit
- the initial conduit to use for data transport
-
-
Method Detail
-
getConduit
public StreamSinkConduit getConduit()
Get the underlying conduit for this channel.- Returns:
- the underlying conduit for this channel
-
setConduit
public void setConduit(StreamSinkConduit conduit)
Set the underlying conduit for this channel.- Parameters:
conduit
- the underlying conduit for this channel
-
getWriteListener
public ChannelListener<? super ConduitStreamSinkChannel> getWriteListener()
Description copied from interface:WriteListenerSettable
Get the write listener.- Specified by:
getWriteListener
in interfaceWriteListenerSettable<ConduitStreamSinkChannel>
- Returns:
- the write listener
-
setWriteListener
public void setWriteListener(ChannelListener<? super ConduitStreamSinkChannel> writeListener)
Description copied from interface:WriteListenerSettable
Set the write listener.- Specified by:
setWriteListener
in interfaceWriteListenerSettable<ConduitStreamSinkChannel>
- Parameters:
writeListener
- the write listener
-
getCloseListener
public ChannelListener<? super ConduitStreamSinkChannel> getCloseListener()
Description copied from interface:CloseListenerSettable
Get the close listener.- Specified by:
getCloseListener
in interfaceCloseListenerSettable<ConduitStreamSinkChannel>
- Returns:
- the close listener
-
setCloseListener
public void setCloseListener(ChannelListener<? super ConduitStreamSinkChannel> closeListener)
Description copied from interface:CloseListenerSettable
Set the close listener.- Specified by:
setCloseListener
in interfaceCloseListenerSettable<ConduitStreamSinkChannel>
- Parameters:
closeListener
- the close listener
-
getWriteSetter
public ChannelListener.Setter<ConduitStreamSinkChannel> getWriteSetter()
Description copied from interface:StreamSinkChannel
Get the setter which can be used to change the write listener for this channel.- Specified by:
getWriteSetter
in interfaceStreamSinkChannel
- Specified by:
getWriteSetter
in interfaceSuspendableWriteChannel
- Returns:
- the setter
-
getCloseSetter
public ChannelListener.Setter<ConduitStreamSinkChannel> getCloseSetter()
Description copied from interface:StreamSinkChannel
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 interfaceStreamSinkChannel
- Specified by:
getCloseSetter
in interfaceSuspendableWriteChannel
- Returns:
- the setter
-
writeFinal
public int writeFinal(java.nio.ByteBuffer src) throws java.io.IOException
Description copied from interface:StreamSinkChannel
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.- Specified by:
writeFinal
in interfaceStreamSinkChannel
- Parameters:
src
- The data to write- Returns:
- The amount of data that was actually written.
- Throws:
java.io.IOException
- See Also:
WritableByteChannel.write(java.nio.ByteBuffer)
,SuspendableWriteChannel.shutdownWrites()
-
writeFinal
public long writeFinal(java.nio.ByteBuffer[] srcs, int offset, int length) throws java.io.IOException
Description copied from interface:StreamSinkChannel
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.- Specified by:
writeFinal
in interfaceStreamSinkChannel
- 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:
java.io.IOException
- See Also:
GatheringByteChannel.write(java.nio.ByteBuffer[], int, int)
,SuspendableWriteChannel.shutdownWrites()
-
writeFinal
public long writeFinal(java.nio.ByteBuffer[] srcs) throws java.io.IOException
Description copied from interface:StreamSinkChannel
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.- Specified by:
writeFinal
in interfaceStreamSinkChannel
- Parameters:
srcs
- The buffers from which bytes are to be retrieved- Returns:
- The amount of data that was actually written
- Throws:
java.io.IOException
- See Also:
GatheringByteChannel.write(java.nio.ByteBuffer[])
,SuspendableWriteChannel.shutdownWrites()
-
suspendWrites
public void suspendWrites()
Description copied from interface:SuspendableWriteChannel
Suspend further write notifications on this channel.- Specified by:
suspendWrites
in interfaceSuspendableWriteChannel
-
resumeWrites
public void resumeWrites()
Description copied from interface:SuspendableWriteChannel
Resume writes on this channel. The write listener will be called as soon as the channel becomes writable.- Specified by:
resumeWrites
in interfaceSuspendableWriteChannel
-
wakeupWrites
public void wakeupWrites()
Description copied from interface:SuspendableWriteChannel
Resume writes
on this channel, and force the write listener to be triggered even if the channel isn't actually writable.- Specified by:
wakeupWrites
in interfaceSuspendableWriteChannel
-
isWriteResumed
public boolean isWriteResumed()
Description copied from interface:SuspendableWriteChannel
Determine whether writes are resumed.- Specified by:
isWriteResumed
in interfaceSuspendableWriteChannel
- Returns:
true
if writes are resumed,false
if writes are suspended
-
awaitWritable
public void awaitWritable() throws java.io.IOException
Description copied from interface:SuspendableWriteChannel
Block until this channel becomes writable again. This method may return spuriously before the channel becomes writable.- Specified by:
awaitWritable
in interfaceSuspendableWriteChannel
- Throws:
java.io.InterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set as welljava.io.IOException
- if an I/O error occurs
-
awaitWritable
public void awaitWritable(long time, java.util.concurrent.TimeUnit timeUnit) throws java.io.IOException
Description copied from interface:SuspendableWriteChannel
Block until this channel becomes writable again, or until the timeout expires. This method may return spuriously before the channel becomes writable or the timeout expires.- Specified by:
awaitWritable
in interfaceSuspendableWriteChannel
- Parameters:
time
- the time to waittimeUnit
- the time unit- Throws:
java.io.InterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set as welljava.io.IOException
- if an I/O error occurs
-
transferFrom
public long transferFrom(java.nio.channels.FileChannel src, long position, long count) throws java.io.IOException
Description copied from interface:StreamSinkChannel
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.- Specified by:
transferFrom
in interfaceStreamSinkChannel
- 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:
java.io.IOException
- if an I/O error occurs
-
transferFrom
public long transferFrom(StreamSourceChannel source, long count, java.nio.ByteBuffer throughBuffer) throws java.io.IOException
Description copied from interface:StreamSinkChannel
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.- Specified by:
transferFrom
in interfaceStreamSinkChannel
- 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:
java.io.IOException
- if an I/O error occurs
-
write
public int write(java.nio.ByteBuffer dst) throws java.io.IOException
- Specified by:
write
in interfacejava.nio.channels.WritableByteChannel
- Throws:
java.io.IOException
-
write
public long write(java.nio.ByteBuffer[] srcs) throws java.io.IOException
- Specified by:
write
in interfacejava.nio.channels.GatheringByteChannel
- Throws:
java.io.IOException
-
write
public long write(java.nio.ByteBuffer[] dsts, int offs, int len) throws java.io.IOException
- Specified by:
write
in interfacejava.nio.channels.GatheringByteChannel
- Throws:
java.io.IOException
-
flush
public boolean flush() throws java.io.IOException
Description copied from interface:SuspendableWriteChannel
Flush any waiting partial send or write. If there is no data to flush, or if the flush completed successfully, this method will returntrue
. If there is data to flush which cannot be immediately written, this method will returnfalse
. If this method returnstrue
afterSuspendableWriteChannel.shutdownWrites()
was called on this channel, the write listener will no longer be invoked on this channel. If this is case and additionally this is a write-only channel or the read side was previously shut down, then the channel will automatically be closed.- Specified by:
flush
in interfaceSuspendableWriteChannel
- Returns:
true
if the message was flushed, orfalse
if the result would block- Throws:
java.io.IOException
- if an I/O error occurs
-
supportsOption
public boolean supportsOption(Option<?> option)
Description copied from interface:Configurable
Determine whether an option is supported on this channel.- Specified by:
supportsOption
in interfaceConfigurable
- Parameters:
option
- the option- Returns:
true
if it is supported
-
getOption
public <T> T getOption(Option<T> option) throws java.io.IOException
Description copied from interface:Configurable
Get the value of a channel option.- Specified by:
getOption
in interfaceConfigurable
- Type Parameters:
T
- the type of the option value- Parameters:
option
- the option to get- Returns:
- the value of the option, or
null
if it is not set - Throws:
java.io.IOException
- if an I/O error occurred when reading the option
-
setOption
public <T> T setOption(Option<T> option, T value) throws java.lang.IllegalArgumentException, java.io.IOException
Description copied from interface:Configurable
Set an option for this channel. Unsupported options are ignored.- Specified by:
setOption
in interfaceConfigurable
- Type Parameters:
T
- the type of the option value- Parameters:
option
- the option to setvalue
- the value of the option to set- Returns:
- the previous option value, if any
- Throws:
java.lang.IllegalArgumentException
- if the value is not acceptable for this optionjava.io.IOException
- if an I/O error occurred when modifying the option
-
shutdownWrites
public void shutdownWrites() throws java.io.IOException
Description copied from interface:SuspendableWriteChannel
Indicate that writing is complete for this channel. Further attempts to write data to this channel after this method is invoked will result in an exception. If this method was already called, calling this method again will have no additional effect. After this method is called, any remaining data still must be flushed out via theSuspendableWriteChannel.flush()
method; once this is done, if the read side of the channel was shut down, the channel will automatically close.- Specified by:
shutdownWrites
in interfaceSuspendableWriteChannel
- Throws:
java.io.IOException
- if an I/O error occurs
-
isOpen
public boolean isOpen()
Description copied from interface:SuspendableWriteChannel
Determine whether this channel is open. This method will returnfalse
if all directions are shut down, even if there is unflushed write data pending.- Specified by:
isOpen
in interfacejava.nio.channels.Channel
- Specified by:
isOpen
in interfaceSuspendableWriteChannel
- Returns:
true
if the channel is open,false
otherwise
-
close
public void close() throws java.io.IOException
Description copied from interface:SuspendableWriteChannel
Close this channel. If data has been written but not flushed, that data may be discarded, depending on the channel implementation. When a channel is closed, its close listener is invoked. Invoking this method more than once has no additional effect.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.nio.channels.Channel
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in interfaceCloseableChannel
- Specified by:
close
in interfacejava.nio.channels.InterruptibleChannel
- Specified by:
close
in interfaceSuspendableWriteChannel
- Throws:
java.io.IOException
- if the close failed
-
getWriteThread
@Deprecated public XnioExecutor getWriteThread()
Deprecated.Description copied from interface:SuspendableWriteChannel
Get the write thread for this channel.- Specified by:
getWriteThread
in interfaceSuspendableWriteChannel
- Returns:
- the thread, or
null
if none is configured or available
-
getIoThread
public XnioIoThread getIoThread()
Description copied from interface:CloseableChannel
Get the I/O thread associated with this channel.- Specified by:
getIoThread
in interfaceCloseableChannel
- Returns:
- the I/O thread associated with this channel
-
getWorker
public XnioWorker getWorker()
Description copied from interface:CloseableChannel
Get the worker for this channel.- Specified by:
getWorker
in interfaceCloseableChannel
- Returns:
- the worker
-
clone
public ConduitStreamSinkChannel clone()
Duplicate this channel. Changing the delegate conduit in one channel will not affect the other.- Overrides:
clone
in classjava.lang.Object
- Returns:
- the cloned channel
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-