Class FixedLengthStreamSourceChannel
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Channel
,InterruptibleChannel
,ReadableByteChannel
,ScatteringByteChannel
,CloseableChannel
,CloseListenerSettable<FixedLengthStreamSourceChannel>
,Configurable
,ProtectedWrappedChannel<StreamSourceChannel>
,ReadListenerSettable<FixedLengthStreamSourceChannel>
,StreamSourceChannel
,SuspendableReadChannel
getRemaining()
to see if more bytes were pending when the channel was
closed.- 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.ReadListenerSettable
ReadListenerSettable.Setter<C extends Channel>
-
Field Summary
Fields inherited from interface org.xnio.channels.Configurable
EMPTY
-
Constructor Summary
ConstructorsConstructorDescriptionFixedLengthStreamSourceChannel
(StreamSourceChannel delegate, long contentLength, boolean configurable, boolean propagateClose, ChannelListener<? super FixedLengthStreamSourceChannel> finishListener, Object guard) Construct a new instance.FixedLengthStreamSourceChannel
(StreamSourceChannel delegate, long contentLength, boolean configurable, ChannelListener<? super FixedLengthStreamSourceChannel> finishListener, Object guard) Construct a new instance.FixedLengthStreamSourceChannel
(StreamSourceChannel delegate, long contentLength, ChannelListener<? super FixedLengthStreamSourceChannel> finishListener, Object guard) Construct a new instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Block until this channel becomes readable again.void
awaitReadable
(long time, TimeUnit timeUnit) Block until this channel becomes readable again, or until the timeout expires.void
close()
Close this channel.getChannel
(Object guard) Get the channel which is wrapped by this object, ornull
if the guard is invalid.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 read listener.Get the setter which can be used to change the read listener for this channel.Deprecated.long
Get the number of remaining bytes.Get the worker for this channel.boolean
isOpen()
boolean
Determine whether reads are resumed.int
read
(ByteBuffer dst) long
read
(ByteBuffer[] dsts) long
read
(ByteBuffer[] dsts, int offset, int length) void
Resume reads on this channel.void
setCloseListener
(ChannelListener<? super FixedLengthStreamSourceChannel> closeListener) Set the close listener.<T> T
Set an option for this channel.void
setReadListener
(ChannelListener<? super FixedLengthStreamSourceChannel> readListener) Set the read listener.void
Places this readable channel at "end of stream".boolean
supportsOption
(Option<?> option) Determine whether an option is supported on this channel.void
Suspend further read notifications on this channel.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.void
Resume reads
on this channel, and force the read listener to be triggered even if the channel isn't actually readable.
-
Constructor Details
-
FixedLengthStreamSourceChannel
public FixedLengthStreamSourceChannel(StreamSourceChannel delegate, long contentLength, ChannelListener<? super FixedLengthStreamSourceChannel> finishListener, Object guard) Construct a new instance. The given listener is called once all the bytes are read from the stream or the stream is closed. This listener should cause the remaining data to be drained from the underlying stream via theinvalid reference
#drain()
Calling this constructor will replace the read listener of the underlying channel. The listener should be restored from the
finishListener
object. The underlying stream should not be closed while this wrapper stream is active.- Parameters:
delegate
- the stream source channel to read fromcontentLength
- the amount of content to readfinishListener
- the listener to call once the stream is exhausted or closedguard
- the guard object to use
-
FixedLengthStreamSourceChannel
public FixedLengthStreamSourceChannel(StreamSourceChannel delegate, long contentLength, boolean configurable, ChannelListener<? super FixedLengthStreamSourceChannel> finishListener, Object guard) Construct a new instance. The given listener is called once all the bytes are read from the stream or the stream is closed. This listener should cause the remaining data to be drained from the underlying stream via theinvalid reference
#drain()
Calling this constructor will replace the read listener of the underlying channel. The listener should be restored from the
finishListener
object. The underlying stream should not be closed while this wrapper stream is active.- Parameters:
delegate
- the stream source channel to read fromcontentLength
- the amount of content to readconfigurable
-true
to allow options to pass through to the delegate,false
otherwisefinishListener
- the listener to call once the stream is exhausted or closedguard
- the guard object to use
-
FixedLengthStreamSourceChannel
public FixedLengthStreamSourceChannel(StreamSourceChannel delegate, long contentLength, boolean configurable, boolean propagateClose, ChannelListener<? super FixedLengthStreamSourceChannel> finishListener, Object guard) Construct a new instance. The given listener is called once all the bytes are read from the stream or the stream is closed. This listener should cause the remaining data to be drained from the underlying stream via theinvalid reference
#drain()
Calling this constructor will replace the read listener of the underlying channel. The listener should be restored from the
finishListener
object. The underlying stream should not be closed while this wrapper stream is active.- Parameters:
delegate
- the stream source channel to read fromcontentLength
- the amount of content to readconfigurable
-true
to allow options to pass through to the delegate,false
otherwisepropagateClose
-true
to propagate close/shutdown to the delegate,false
otherwisefinishListener
- the listener to call once the stream is exhausted or closedguard
- the guard object to use
-
-
Method Details
-
setReadListener
Description copied from interface:ReadListenerSettable
Set the read listener.- Specified by:
setReadListener
in interfaceReadListenerSettable<FixedLengthStreamSourceChannel>
- Parameters:
readListener
- the read listener
-
getReadListener
Description copied from interface:ReadListenerSettable
Get the read listener.- Specified by:
getReadListener
in interfaceReadListenerSettable<FixedLengthStreamSourceChannel>
- Returns:
- the read listener
-
setCloseListener
Description copied from interface:CloseListenerSettable
Set the close listener.- Specified by:
setCloseListener
in interfaceCloseListenerSettable<FixedLengthStreamSourceChannel>
- Parameters:
closeListener
- the close listener
-
getCloseListener
Description copied from interface:CloseListenerSettable
Get the close listener.- Specified by:
getCloseListener
in interfaceCloseListenerSettable<FixedLengthStreamSourceChannel>
- Returns:
- the close listener
-
getReadSetter
Description copied from interface:StreamSourceChannel
Get the setter which can be used to change the read listener for this channel.- Specified by:
getReadSetter
in interfaceStreamSourceChannel
- Specified by:
getReadSetter
in interfaceSuspendableReadChannel
- Returns:
- the setter
-
getCloseSetter
Description copied from interface:StreamSourceChannel
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 interfaceStreamSourceChannel
- Specified by:
getCloseSetter
in interfaceSuspendableReadChannel
- Returns:
- the setter
-
transferTo
Description copied from interface:StreamSourceChannel
Transfers bytes into the given file from this channel. Using this method in preference toFileChannel.transferFrom(ReadableByteChannel, long, long)
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:
transferTo
in interfaceStreamSourceChannel
- Parameters:
position
- the position within the file from which the transfer is to begincount
- the number of bytes to be transferredtarget
- 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:StreamSourceChannel
Transfers bytes into the given channel target. 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 possibly be empty or may contain data. If this method returns a value less thancount
, then the remaining data inthroughBuffer
may contain data read from this channel which must be written totarget
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. Note that the return value is the amount of data that was actually transferred to theStreamSinkChannel
. The actual amount of data read could be larger than this, and can be calculated by adding the return value and the amount of data left inthroughBuffer
.- Specified by:
transferTo
in interfaceStreamSourceChannel
- Parameters:
count
- the number of bytes to be transferredthroughBuffer
- 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
- Specified by:
read
in interfaceScatteringByteChannel
- Throws:
IOException
-
read
- Specified by:
read
in interfaceScatteringByteChannel
- Throws:
IOException
-
read
- Specified by:
read
in interfaceReadableByteChannel
- Throws:
IOException
-
suspendReads
public void suspendReads()Description copied from interface:SuspendableReadChannel
Suspend further read notifications on this channel.- Specified by:
suspendReads
in interfaceSuspendableReadChannel
-
resumeReads
public void resumeReads()Description copied from interface:SuspendableReadChannel
Resume reads on this channel. The read listener will be called as soon as there is data available to be read.- Specified by:
resumeReads
in interfaceSuspendableReadChannel
-
isReadResumed
public boolean isReadResumed()Description copied from interface:SuspendableReadChannel
Determine whether reads are resumed.- Specified by:
isReadResumed
in interfaceSuspendableReadChannel
- Returns:
true
if reads are resumed,false
if reads are suspended
-
wakeupReads
public void wakeupReads()Description copied from interface:SuspendableReadChannel
Resume reads
on this channel, and force the read listener to be triggered even if the channel isn't actually readable.- Specified by:
wakeupReads
in interfaceSuspendableReadChannel
-
shutdownReads
Description copied from interface:SuspendableReadChannel
Places this readable channel at "end of stream". Further reads will result in EOF. Shutting down all directions of a channel will causeCloseableChannel.close()
to be called automatically.- Specified by:
shutdownReads
in interfaceSuspendableReadChannel
- Throws:
IOException
- if an I/O error occurs
-
awaitReadable
Description copied from interface:SuspendableReadChannel
Block until this channel becomes readable again. This method may return spuriously before the channel becomes readable.- Specified by:
awaitReadable
in interfaceSuspendableReadChannel
- Throws:
IOException
- if an I/O error occurs
-
awaitReadable
Description copied from interface:SuspendableReadChannel
Block until this channel becomes readable again, or until the timeout expires. This method may return spuriously before the channel becomes readable or the timeout expires.- Specified by:
awaitReadable
in interfaceSuspendableReadChannel
- Parameters:
time
- the time to waittimeUnit
- the time unit- Throws:
IOException
- if an I/O error occurs
-
getReadThread
Deprecated.Description copied from interface:SuspendableReadChannel
Get the read thread for this channel.- Specified by:
getReadThread
in interfaceSuspendableReadChannel
- Returns:
- the thread, or
null
if none is configured or available
-
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
Description copied from interface:CloseableChannel
Get the worker for this channel.- Specified by:
getWorker
in interfaceCloseableChannel
- Returns:
- the worker
-
isOpen
public boolean isOpen() -
close
Description copied from interface:CloseableChannel
Close this channel. 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
- 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
-
getChannel
Description copied from interface:ProtectedWrappedChannel
Get the channel which is wrapped by this object, ornull
if the guard is invalid.- Specified by:
getChannel
in interfaceProtectedWrappedChannel<StreamSourceChannel>
- Parameters:
guard
- the guard object- Returns:
- the wrapped channel
-
getRemaining
public long getRemaining()Get the number of remaining bytes.- Returns:
- the number of remaining bytes
-