-
- All Superinterfaces:
java.lang.AutoCloseable
,java.nio.channels.Channel
,java.io.Closeable
,CloseableChannel
,Configurable
,java.nio.channels.InterruptibleChannel
- All Known Subinterfaces:
BoundMultipointMessageChannel
,ConnectedMessageChannel
,ConnectedSslStreamChannel
,ConnectedStreamChannel
,MessageChannel
,MulticastMessageChannel
,MultipointMessageChannel
,ReadableMessageChannel
,ReadableMultipointMessageChannel
,StreamChannel
,StreamSourceChannel
,SuspendableChannel
- All Known Implementing Classes:
AssembledConnectedMessageChannel
,AssembledConnectedSslStreamChannel
,AssembledConnectedStreamChannel
,AssembledMessageChannel
,AssembledStreamChannel
,ConduitReadableMessageChannel
,ConduitStreamSourceChannel
,EmptyStreamSourceChannel
,FixedLengthStreamSourceChannel
,FramedMessageChannel
,PushBackStreamChannel
,SplitStreamSourceChannel
,TranslatingSuspendableChannel
public interface SuspendableReadChannel extends CloseableChannel
A suspendable readable channel. This type of channel is associated with a listener which can suspend and resume reads as needed.
-
-
Field Summary
-
Fields inherited from interface org.xnio.channels.Configurable
EMPTY
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
awaitReadable()
Block until this channel becomes readable again.void
awaitReadable(long time, java.util.concurrent.TimeUnit timeUnit)
Block until this channel becomes readable again, or until the timeout expires.ChannelListener.Setter<? extends SuspendableReadChannel>
getCloseSetter()
Get the setter which can be used to change the close listener for this channel.ChannelListener.Setter<? extends SuspendableReadChannel>
getReadSetter()
Get the setter which can be used to change the read listener for this channel.XnioExecutor
getReadThread()
Deprecated.TheCloseableChannel.getIoThread()
method should be used instead.boolean
isReadResumed()
Determine whether reads are resumed.void
resumeReads()
Resume reads on this channel.void
shutdownReads()
Places this readable channel at "end of stream".void
suspendReads()
Suspend further read notifications on this channel.void
wakeupReads()
Deprecated.Users should instead submitRunnable
tasks to the channel thread when this functionality is needed.-
Methods inherited from interface org.xnio.channels.CloseableChannel
close, getIoThread, getWorker
-
Methods inherited from interface org.xnio.channels.Configurable
getOption, setOption, supportsOption
-
-
-
-
Method Detail
-
suspendReads
void suspendReads()
Suspend further read notifications on this channel.
-
resumeReads
void resumeReads()
Resume reads on this channel. The read listener will be called as soon as there is data available to be read.
-
isReadResumed
boolean isReadResumed()
Determine whether reads are resumed.- Returns:
true
if reads are resumed,false
if reads are suspended
-
wakeupReads
@Deprecated void wakeupReads()
Deprecated.Users should instead submitRunnable
tasks to the channel thread when this functionality is needed.Resume reads
on this channel, and force the read listener to be triggered even if the channel isn't actually readable.
-
shutdownReads
void shutdownReads() throws java.io.IOException
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.- Throws:
java.io.IOException
- if an I/O error occurs
-
awaitReadable
void awaitReadable() throws java.io.IOException
Block until this channel becomes readable again. This method may return spuriously before the channel becomes readable.- 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- Since:
- 1.2
-
awaitReadable
void awaitReadable(long time, java.util.concurrent.TimeUnit timeUnit) throws java.io.IOException
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.- 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- Since:
- 1.2
-
getReadThread
@Deprecated XnioExecutor getReadThread()
Deprecated.TheCloseableChannel.getIoThread()
method should be used instead.Get the read thread for this channel.- Returns:
- the thread, or
null
if none is configured or available
-
getReadSetter
ChannelListener.Setter<? extends SuspendableReadChannel> getReadSetter()
Get the setter which can be used to change the read listener for this channel.- Returns:
- the setter
- Since:
- 2.0
-
getCloseSetter
ChannelListener.Setter<? extends SuspendableReadChannel> 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
- Returns:
- the setter
-
-