| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public abstract class SelectableChannel extends AbstractInterruptibleChannel implements Channel
A channel that can be multiplexed via a {@link Selector}.
In order to be used with a selector, an instance of this class must first be registered via the {@link #register(Selector,int,Object) register} method. This method returns a new {@link SelectionKey} object that represents the channel's registration with the selector.
Once registered with a selector, a channel remains registered until it is deregistered. This involves deallocating whatever resources were allocated to the channel by the selector.
A channel cannot be deregistered directly; instead, the key representing its registration must be cancelled. Cancelling a key requests that the channel be deregistered during the selector's next selection operation. A key may be cancelled explicitly by invoking its {@link SelectionKey#cancel() cancel} method. All of a channel's keys are cancelled implicitly when the channel is closed, whether by invoking its {@link Channel#close close} method or by interrupting a thread blocked in an I/O operation upon the channel.
If the selector itself is closed then the channel will be deregistered, and the key representing its registration will be invalidated, without further delay.
A channel may be registered at most once with any particular selector.
Whether or not a channel is registered with one or more selectors may be determined by invoking the {@link #isRegistered isRegistered} method.
Selectable channels are safe for use by multiple concurrent threads.
Newly-created selectable channels are always in blocking mode. Non-blocking mode is most useful in conjunction with selector-based multiplexing. A channel must be placed into non-blocking mode before being registered with a selector, and may not be returned to blocking mode until it has been deregistered.
Constructor Summary | |
---|---|
protected |
Initializes a new instance of this class. |
Method Summary | |
---|---|
abstract Object |
Retrieves the object upon which the java.nio.channels.SelectableChannel.configureBlocking and java.nio.channels.SelectableChannel.register methods synchronize. |
abstract SelectableChannel |
configureBlocking(boolean block) Adjusts this channel's blocking mode. |
abstract boolean |
Tells whether or not every I/O operation on this channel will block until it completes. |
abstract boolean |
Tells whether or not this channel is currently registered with any selectors. |
abstract SelectionKey |
Retrieves the key representing the channel's registration with the given selector. |
abstract SelectorProvider |
provider() Returns the provider that created this channel. |
SelectionKey |
Registers this channel with the given selector, returning a selection key. |
abstract SelectionKey |
Registers this channel with the given selector, returning a selection key. |
abstract int |
validOps() Returns an operation set identifying this channel's supported operations. |
Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel |
---|
begin, close, end, implCloseChannel, isOpen |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected SelectableChannel()
Method Detail |
---|
public abstract Object blockingLock()
public abstract SelectableChannel configureBlocking(boolean block) throws IOException
If this channel is registered with one or more selectors then an attempt to place it into blocking mode will cause an {@link IllegalBlockingModeException} to be thrown.
This method may be invoked at any time. The new blocking mode will only affect I/O operations that are initiated after this method returns. For some implementations this may require blocking until all pending I/O operations are complete.
If this method is invoked while another invocation of this method or of the {@link #register(Selector, int) register} method is in progress then it will first block until the other operation is complete.
block
- If true then this channel will be placed in
blocking mode; if false then it will be placed
non-blocking modeIOException
- If an I/O error occurspublic abstract boolean isBlocking()
If this channel is closed then the value returned by this method is not specified.
public abstract boolean isRegistered()
Due to the inherent delay between key cancellation and channel deregistration, a channel may remain registered for some time after all of its keys have been cancelled. A channel may also remain registered for some time after it is closed.
public abstract SelectionKey keyFor(Selector sel)
sel
public abstract SelectorProvider provider()
public final SelectionKey register(Selector sel, int ops) throws ClosedChannelException
An invocation of this convenience method of the form
sc.register(sel, ops)behaves in exactly the same way as the invocation
sc.{@link #register(java.nio.channels.Selector,int,java.lang.Object) register}(sel, ops, null)
sel
- The selector with which this channel is to be registeredops
- The interest set for the resulting keyClosedChannelException
- If this channel is closedpublic abstract SelectionKey register(Selector sel, int ops, Object att) throws ClosedChannelException
If this channel is currently registered with the given selector then the selection key representing that registration is returned. The key's interest set will have been changed to ops, as if by invoking the {@link SelectionKey#interestOps(int) interestOps(int)} method. If the att argument is not null then the key's attachment will have been set to that value. A {@link CancelledKeyException} will be thrown if the key has already been cancelled.
Otherwise this channel has not yet been registered with the given selector, so it is registered and the resulting new key is returned. The key's initial interest set will be ops and its attachment will be att.
This method may be invoked at any time. If this method is invoked while another invocation of this method or of the {@link #configureBlocking(boolean) configureBlocking} method is in progress then it will first block until the other operation is complete. This method will then synchronize on the selector's key set and therefore may block if invoked concurrently with another registration or selection operation involving the same selector.
If this channel is closed while this operation is in progress then the key returned by this method will have been cancelled and will therefore be invalid.
sel
- The selector with which this channel is to be registeredops
- The interest set for the resulting keyatt
- The attachment for the resulting key; may be nullClosedChannelException
- If this channel is closedpublic abstract int validOps()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |