|
XNIO API 3.1.0.Beta1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SuspendableReadChannel
A suspendable readable channel. This type of channel is associated with a listener which can suspend and resume reads as needed.
Method Summary | |
---|---|
void |
awaitReadable()
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. |
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()
Get the read thread for this channel. |
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()
Resume reads on this channel, and force the read listener to be triggered even if the
channel isn't actually readable. |
Methods inherited from interface org.xnio.channels.CloseableChannel |
---|
close, getWorker |
Methods inherited from interface java.nio.channels.Channel |
---|
isOpen |
Methods inherited from interface org.xnio.channels.Configurable |
---|
getOption, setOption, supportsOption |
Method Detail |
---|
void suspendReads()
void resumeReads()
boolean isReadResumed()
true
if reads are resumed, false
if reads are suspendedvoid wakeupReads()
Resume reads
on this channel, and force the read listener to be triggered even if the
channel isn't actually readable.
void shutdownReads() throws IOException
CloseableChannel.close()
to be called automatically.
IOException
- if an I/O error occursvoid awaitReadable() throws IOException
InterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set as well
IOException
- if an I/O error occursvoid awaitReadable(long time, TimeUnit timeUnit) throws IOException
time
- the time to waittimeUnit
- the time unit
InterruptedIOException
- if the operation is interrupted; the thread's interrupt flag will be set as well
IOException
- if an I/O error occursXnioExecutor getReadThread()
null
if none is configured or availableChannelListener.Setter<? extends SuspendableReadChannel> getReadSetter()
ChannelListener.Setter<? extends SuspendableReadChannel> getCloseSetter()
getCloseSetter
in interface CloseableChannel
|
XNIO API 3.1.0.Beta1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |