XNIO API 3.8.13.Final · org.xnio.channels.SuspendableAcceptChannel

Method Summary

Modifier and Type	Method and Description
public void	awaitAcceptable() Block until this channel becomes acceptable again.
public void	awaitAcceptable(long the time to wait time, TimeUnit the time unit timeUnit) Block until this channel becomes acceptable again, or until the timeout expires.
public ChannelListener.Setter<? extends SuspendableAcceptChannel>	Returns: the setter getAcceptSetter() Get the setter which can be used to change the accept listener for this channel.
public XnioExecutor	Returns: the thread getAcceptThread() Deprecated The `getIoThread()` method should be used instead. Get an accept thread for this channel.
public ChannelListener.Setter<? extends SuspendableAcceptChannel>	getCloseSetter() Redeclares org.xnio.channels.CloseableChannel.getCloseSetter. Get the setter which can be used to change the close listener for this channel.
public XnioIoThread	Returns: the thread getIoThread() Redeclares org.xnio.channels.CloseableChannel.getIoThread. Get an accept thread for this channel.
public boolean	Returns: `true` if accepts are resumed, `false` if accepts are suspended isAcceptResumed() Determine whether accepts are resumed.
public void	resumeAccepts() Resume reads on this channel.
public void	suspendAccepts() Suspend further read notifications on this channel.
public void	wakeupAccepts() Deprecated Users should instead submit `Runnable` tasks to the channel thread when this functionality is needed. `resumeAccepts()` Resume accepts} on this channel, and force the accept listener to be triggered even if the channel isn't actually ready.

Inherited from org.xnio.channels.CloseableChannel:: close getWorker

Method Detail

awaitAcceptable	back to summary
public void awaitAcceptable() throws IOException Block until this channel becomes acceptable again. This method may return spuriously before the channel becomes acceptable. Exceptions IOException: if an I/O error occurs InterruptedIOException: if the operation is interrupted; the thread's interrupt flag will be set as well

awaitAcceptable

back to summary

public void awaitAcceptable() throws IOException

Block until this channel becomes acceptable again. This method may return spuriously before the channel becomes acceptable.

Exceptions

IOException:: if an I/O error occurs
InterruptedIOException:: if the operation is interrupted; the thread's interrupt flag will be set as well

awaitAcceptable	back to summary
public void awaitAcceptable(long time, TimeUnit timeUnit) throws IOException Block until this channel becomes acceptable again, or until the timeout expires. This method may return spuriously before the channel becomes acceptable or the timeout expires. Parameters time:long the time to wait timeUnit:TimeUnit the time unit Exceptions IOException: if an I/O error occurs InterruptedIOException: if the operation is interrupted; the thread's interrupt flag will be set as well

awaitAcceptable

back to summary

public void awaitAcceptable(long time, TimeUnit timeUnit) throws IOException

Block until this channel becomes acceptable again, or until the timeout expires. This method may return spuriously before the channel becomes acceptable or the timeout expires.

Parameters

time:long: the time to wait
timeUnit:TimeUnit: the time unit

Exceptions

IOException:: if an I/O error occurs
InterruptedIOException:: if the operation is interrupted; the thread's interrupt flag will be set as well

getAcceptSetter	back to summary
public ChannelListener.Setter<? extends SuspendableAcceptChannel> getAcceptSetter() Get the setter which can be used to change the accept listener for this channel. Returns:ChannelListener.Setter<? extends SuspendableAcceptChannel> the setter

getAcceptSetter

back to summary

public ChannelListener.Setter<? extends SuspendableAcceptChannel> getAcceptSetter()

Get the setter which can be used to change the accept listener for this channel.

Returns:ChannelListener.Setter<? extends SuspendableAcceptChannel>: the setter

getAcceptThread back to summary

getAcceptThread	back to summary
public XnioExecutor getAcceptThread() Deprecated The `getIoThread()` method should be used instead. Get an accept thread for this channel. If more than one is configured, any of them may be returned. Returns:XnioExecutor the thread Annotations @Deprecated

public XnioExecutor getAcceptThread()

Deprecated

The getIoThread() method should be used instead.

Get an accept thread for this channel. If more than one is configured, any of them may be returned.

Returns:XnioExecutor

the thread

Annotations

@Deprecated

getCloseSetter	back to summary
public ChannelListener.Setter<? extends SuspendableAcceptChannel> getCloseSetter() Redeclares org.xnio.channels.CloseableChannel.getCloseSetter. Doc from org.xnio.channels.CloseableChannel.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. Returns:ChannelListener.Setter<? extends SuspendableAcceptChannel> the setter

getCloseSetter

back to summary

public ChannelListener.Setter<? extends SuspendableAcceptChannel> getCloseSetter()

Redeclares org.xnio.channels.CloseableChannel.getCloseSetter.

Doc from org.xnio.channels.CloseableChannel.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.

Returns:ChannelListener.Setter<? extends SuspendableAcceptChannel>: the setter

getIoThread	back to summary
public XnioIoThread getIoThread() Redeclares org.xnio.channels.CloseableChannel.getIoThread. Get an accept thread for this channel. If more than one is configured, any of them may be returned. Returns:XnioIoThread the thread

getIoThread

back to summary

public XnioIoThread getIoThread()

Redeclares org.xnio.channels.CloseableChannel.getIoThread.

Get an accept thread for this channel. If more than one is configured, any of them may be returned.

Returns:XnioIoThread: the thread

isAcceptResumed back to summary

isAcceptResumed	back to summary
public boolean isAcceptResumed() Determine whether accepts are resumed. Returns:boolean `true` if accepts are resumed, `false` if accepts are suspended

public boolean isAcceptResumed()

Determine whether accepts are resumed.

Returns:boolean: true if accepts are resumed, false if accepts are suspended

resumeAccepts	back to summary
public void resumeAccepts() Resume reads on this channel. The accept listener will be called as soon as there is a connection available to be accepted.

suspendAccepts	back to summary
public void suspendAccepts() Suspend further read notifications on this channel.

wakeupAccepts back to summary

wakeupAccepts	back to summary
public void wakeupAccepts() Deprecated Users should instead submit `Runnable` tasks to the channel thread when this functionality is needed. `resumeAccepts()` Resume accepts} on this channel, and force the accept listener to be triggered even if the channel isn't actually ready. Annotations @Deprecated

public void wakeupAccepts()

Deprecated

Users should instead submit Runnable tasks to the channel thread when this functionality is needed.

resumeAccepts() Resume accepts} on this channel, and force the accept listener to be triggered even if the channel isn't actually ready.

Annotations

@Deprecated

public Interface SuspendableAcceptChannel

Method Summary

Method Detail