Package org.xnio.channels
Class NullStreamSinkChannel
java.lang.Object
org.xnio.channels.NullStreamSinkChannel
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Channel
,GatheringByteChannel
,InterruptibleChannel
,WritableByteChannel
,CloseableChannel
,CloseListenerSettable<NullStreamSinkChannel>
,Configurable
,StreamSinkChannel
,SuspendableWriteChannel
,WriteListenerSettable<NullStreamSinkChannel>
public final class NullStreamSinkChannel
extends Object
implements StreamSinkChannel, WriteListenerSettable<NullStreamSinkChannel>, CloseListenerSettable<NullStreamSinkChannel>
A bit-bucket stream sink channel. This channel type is always writable.
- Author:
- David M. Lloyd
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xnio.channels.CloseListenerSettable
CloseListenerSettable.Setter<C extends Channel>
Nested classes/interfaces inherited from interface org.xnio.channels.WriteListenerSettable
WriteListenerSettable.Setter<C extends Channel>
-
Field Summary
Fields inherited from interface org.xnio.channels.Configurable
EMPTY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Block until this channel becomes writable again.void
awaitWritable
(long time, TimeUnit timeUnit) Block until this channel becomes writable again, or until the timeout expires.void
close()
Close this channel.boolean
flush()
Flush any waiting partial send or write.ChannelListener<? super NullStreamSinkChannel>
Get the close listener.Get the setter which can be used to change the close listener for this channel.Get the I/O thread associated with this channel.<T> T
Get the value of a channel option.Get the worker for this channel.ChannelListener<? super NullStreamSinkChannel>
Get the write listener.Get the setter which can be used to change the write listener for this channel.Deprecated.boolean
isOpen()
Determine whether this channel is open.boolean
Determine whether writes are resumed.void
Resume writes on this channel.void
setCloseListener
(ChannelListener<? super NullStreamSinkChannel> closeListener) Set the close listener.<T> T
Set an option for this channel.void
setWriteListener
(ChannelListener<? super NullStreamSinkChannel> writeListener) Set the write listener.void
Indicate that writing is complete for this channel.boolean
supportsOption
(Option<?> option) Determine whether an option is supported on this channel.void
Suspend further write notifications on 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.void
Resume writes
on this channel, and force the write listener to be triggered even if the channel isn't actually writable.int
write
(ByteBuffer src) long
write
(ByteBuffer[] srcs) long
write
(ByteBuffer[] srcs, int offset, int length) 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)
.
-
Constructor Details
-
NullStreamSinkChannel
Construct a new instance.- Parameters:
thread
- the write thread for this channel
-
-
Method Details
-
getWorker
Description copied from interface:CloseableChannel
Get the worker for this channel.- Specified by:
getWorker
in interfaceCloseableChannel
- Returns:
- the worker
-
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
-
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
-
transferFrom
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:
IOException
- if an I/O error occurs
-
transferFrom
public long transferFrom(StreamSourceChannel source, long count, ByteBuffer throughBuffer) throws 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:
IOException
- if an I/O error occurs
-
setWriteListener
Description copied from interface:WriteListenerSettable
Set the write listener.- Specified by:
setWriteListener
in interfaceWriteListenerSettable<NullStreamSinkChannel>
- Parameters:
writeListener
- the write listener
-
getWriteListener
Description copied from interface:WriteListenerSettable
Get the write listener.- Specified by:
getWriteListener
in interfaceWriteListenerSettable<NullStreamSinkChannel>
- Returns:
- the write listener
-
setCloseListener
Description copied from interface:CloseListenerSettable
Set the close listener.- Specified by:
setCloseListener
in interfaceCloseListenerSettable<NullStreamSinkChannel>
- Parameters:
closeListener
- the close listener
-
getCloseListener
Description copied from interface:CloseListenerSettable
Get the close listener.- Specified by:
getCloseListener
in interfaceCloseListenerSettable<NullStreamSinkChannel>
- Returns:
- the close listener
-
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
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
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:
IOException
- See Also:
-
writeFinal
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:
IOException
- See Also:
-
writeFinal
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:
IOException
- See Also:
-
write
- Specified by:
write
in interfaceWritableByteChannel
- Throws:
IOException
-
write
- Specified by:
write
in interfaceGatheringByteChannel
- Throws:
IOException
-
write
- Specified by:
write
in interfaceGatheringByteChannel
- Throws:
IOException
-
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
-
shutdownWrites
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:
IOException
- if an I/O error occurs
-
awaitWritable
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:
InterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set as wellIOException
- if an I/O error occurs
-
awaitWritable
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:
InterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set as wellIOException
- if an I/O error occurs
-
flush
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:
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 interfaceChannel
- Specified by:
isOpen
in interfaceSuspendableWriteChannel
- Returns:
true
if the channel is open,false
otherwise
-
close
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 interfaceAutoCloseable
- Specified by:
close
in interfaceChannel
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceCloseableChannel
- Specified by:
close
in interfaceInterruptibleChannel
- Specified by:
close
in interfaceSuspendableWriteChannel
- Throws:
IOException
- if the close failed
-
supportsOption
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
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:
IOException
- if an I/O error occurred when reading the option
-
setOption
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:
IllegalArgumentException
- if the value is not acceptable for this optionIOException
- if an I/O error occurred when modifying the option
-