# SelectableChannel

public abstract class **SelectableChannel** extends [AbstractInterruptibleChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AbstractInterruptibleChannel.html)  
implements [Channel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Channel.html)

|---|---|---|
| Known Direct Subclasses [AbstractSelectableChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AbstractSelectableChannel.html) |---|---| | [AbstractSelectableChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AbstractSelectableChannel.html) | Base implementation class for selectable channels. | |||

|---|---|---|
| Known Indirect Subclasses [DatagramChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html), [Pipe.SinkChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Pipe.SinkChannel.html), [Pipe.SourceChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Pipe.SourceChannel.html), [ServerSocketChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ServerSocketChannel.html), [SocketChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SocketChannel.html) |---|---| | [DatagramChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/DatagramChannel.html) | A selectable channel for datagram-oriented sockets. | | [Pipe.SinkChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Pipe.SinkChannel.html) | A channel representing the writable end of a `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Pipe.html`. | | [Pipe.SourceChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Pipe.SourceChannel.html) | A channel representing the readable end of a `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Pipe.html`. | | [ServerSocketChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ServerSocketChannel.html) | A selectable channel for stream-oriented listening sockets. | | [SocketChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SocketChannel.html) | A selectable channel for stream-oriented connecting sockets. | |||

A channel that can be multiplexed via a `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Selector.html`.

In order to be used with a selector, an instance of this class must
first be *registered* via the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#register(java.nio.channels.Selector,%20int,%20java.lang.Object)` method. This method returns a new `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html` 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html#cancel()` method. All of a channel's keys are cancelled
implicitly when the channel is closed, whether by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Channel.html#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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#isRegistered()` method.

Selectable channels are safe for use by multiple concurrent
threads.

## Blocking mode

A selectable channel is either in *blocking* mode or in *non-blocking* mode. In blocking mode, every I/O operation invoked upon the channel will block until it completes. In non-blocking mode an I/O operation will never block and may transfer fewer bytes than were requested or possibly no bytes at all. The blocking mode of a selectable channel may be determined by invoking its `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#isBlocking()` method.

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.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Selector.html`

### Protected Constructor Summary

|---|---|
|   | [SelectableChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#SelectableChannel())() Initializes a new instance of this class. |

### Public Method Summary

|---|---|
| abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [blockingLock](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#blockingLock())() Retrieves the object upon which the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#configureBlocking(boolean)` and `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#register(java.nio.channels.Selector,%20int)` methods synchronize. |
| abstract [SelectableChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html) | [configureBlocking](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#configureBlocking(boolean))(boolean block) Adjusts this channel's blocking mode. |
| abstract boolean | [isBlocking](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#isBlocking())() Tells whether or not every I/O operation on this channel will block until it completes. |
| abstract boolean | [isRegistered](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#isRegistered())() Tells whether or not this channel is currently registered with any selectors. |
| abstract [SelectionKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html) | [keyFor](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#keyFor(java.nio.channels.Selector))([Selector](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Selector.html) sel) Retrieves the key representing the channel's registration with the given selector. |
| abstract [SelectorProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/SelectorProvider.html) | [provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#provider())() Returns the provider that created this channel. |
| abstract [SelectionKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html) | [register](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#register(java.nio.channels.Selector,%20int,%20java.lang.Object))([Selector](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Selector.html) sel, int ops, [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) att) Registers this channel with the given selector, returning a selection key. |
| final [SelectionKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html) | [register](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#register(java.nio.channels.Selector,%20int))([Selector](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Selector.html) sel, int ops) Registers this channel with the given selector, returning a selection key. |
| abstract int | [validOps](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#validOps())() Returns an [operation set](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey#opsets) identifying this channel's supported operations. |

### Inherited Method Summary

From class [java.nio.channels.spi.AbstractInterruptibleChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AbstractInterruptibleChannel.html)

|---|---|
| final void | [begin](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AbstractInterruptibleChannel.html#begin())() Marks the beginning of an I/O operation that might block indefinitely. |
| final void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AbstractInterruptibleChannel.html#close())() Closes this channel. |
| final void | [end](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AbstractInterruptibleChannel.html#end(boolean))(boolean completed) Marks the end of an I/O operation that might block indefinitely. |
| abstract void | [implCloseChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AbstractInterruptibleChannel.html#implCloseChannel())() Closes this channel. |
| final boolean | [isOpen](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AbstractInterruptibleChannel.html#isOpen())() Tells whether or not this channel is open. |

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

From interface [java.nio.channels.Channel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Channel.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Channel.html#close())() Closes this channel. |
| abstract boolean | [isOpen](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Channel.html#isOpen())() Tells whether or not this channel is open. |

From interface [java.nio.channels.InterruptibleChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/InterruptibleChannel.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/InterruptibleChannel.html#close())() Closes this channel. |

From interface [java.io.Closeable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Closeable.html#close())() Closes this stream and releases any system resources associated with it. |

From interface [java.lang.AutoCloseable](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html)

|---|---|
| abstract void | [close](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/AutoCloseable.html#close())() Closes this resource, relinquishing any underlying resources. |

## Protected Constructors

#### protected
**SelectableChannel**
()

Initializes a new instance of this class.

## Public Methods

#### public abstract [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)
**blockingLock**
()

Retrieves the object upon which the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#configureBlocking(boolean)` and `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#register(java.nio.channels.Selector,%20int)` methods synchronize.
This is often useful in the implementation of adaptors that require a
specific blocking mode to be maintained for a short period of time.

##### Returns

- The blocking-mode lock object

#### public abstract [SelectableChannel](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html)
**configureBlocking**
(boolean block)

Adjusts this channel's blocking mode.

If this channel is registered with one or more selectors then an
attempt to place it into blocking mode will cause an `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/IllegalBlockingModeException.html` 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#register(java.nio.channels.Selector,%20int)` method is in progress
then it will first block until the other operation is complete.

<br />

##### Parameters

| block | If true then this channel will be placed in blocking mode; if false then it will be placed non-blocking mode |
|---|---|

##### Returns

- This selectable channel

##### Throws

| [ClosedChannelException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ClosedChannelException.html) | If this channel is closed |
| [IllegalBlockingModeException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/IllegalBlockingModeException.html) | If block is true and this channel is registered with one or more selectors |
| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|

#### public abstract boolean
**isBlocking**
()

Tells whether or not every I/O operation on this channel will block
until it completes. A newly-created channel is always in blocking mode.

If this channel is closed then the value returned by this method is
not specified.

<br />

##### Returns

- true if, and only if, this channel is in blocking mode

#### public abstract boolean
**isRegistered**
()

Tells whether or not this channel is currently registered with any
selectors. A newly-created channel is not registered.

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.

<br />

##### Returns

- true if, and only if, this channel is registered

#### public abstract [SelectionKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html)
**keyFor**
([Selector](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Selector.html) sel)

Retrieves the key representing the channel's registration with the given
selector.

##### Parameters

| sel | The selector |
|---|---|

##### Returns

- The key returned when this channel was last registered with the given selector, or null if this channel is not currently registered with that selector

#### public abstract [SelectorProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/SelectorProvider.html)
**provider**
()

Returns the provider that created this channel.

##### Returns

- The provider that created this channel

#### public abstract [SelectionKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html)
**register**
([Selector](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Selector.html) sel, int ops, [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) att)

Registers this channel with the given selector, returning a selection
key.

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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html#interestOps(int)` method. If
the att argument is not null then the key's attachment
will have been set to that value. A `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/CancelledKeyException.html` 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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#configureBlocking(boolean)` 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.

<br />

##### Parameters

| sel | The selector with which this channel is to be registered |
| ops | The interest set for the resulting key |
| att | The attachment for the resulting key; may be null |
|---|---|

##### Returns

- A key representing the registration of this channel with the given selector

##### Throws

| [ClosedChannelException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ClosedChannelException.html) | If this channel is closed |
| [ClosedSelectorException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ClosedSelectorException.html) | If the selector is closed |
| [IllegalBlockingModeException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/IllegalBlockingModeException.html) | If this channel is in blocking mode |
| [IllegalSelectorException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/IllegalSelectorException.html) | If this channel was not created by the same provider as the given selector |
| [CancelledKeyException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/CancelledKeyException.html) | If this channel is currently registered with the given selector but the corresponding key has already been cancelled |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If a bit in the ops set does not correspond to an operation that is supported by this channel, that is, if `set & ~validOps() != 0` |
|---|---|

#### public final [SelectionKey](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey.html)
**register**
([Selector](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/Selector.html) sel, int ops)

Registers this channel with the given selector, returning a selection
key.

An invocation of this convenience method of the form

> sc.register(sel, ops)
behaves in exactly the same way as the invocation sc.`https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectableChannel.html#register(java.nio.channels.Selector,%20int,%20java.lang.Object)`(sel, ops, null)

<br />

##### Parameters

| sel | The selector with which this channel is to be registered |
| ops | The interest set for the resulting key |
|---|---|

##### Returns

- A key representing the registration of this channel with the given selector

##### Throws

| [ClosedChannelException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ClosedChannelException.html) | If this channel is closed |
| [ClosedSelectorException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ClosedSelectorException.html) | If the selector is closed |
| [IllegalBlockingModeException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/IllegalBlockingModeException.html) | If this channel is in blocking mode |
| [IllegalSelectorException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/IllegalSelectorException.html) | If this channel was not created by the same provider as the given selector |
| [CancelledKeyException](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/CancelledKeyException.html) | If this channel is currently registered with the given selector but the corresponding key has already been cancelled |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If a bit in ops does not correspond to an operation that is supported by this channel, that is, if `set & ~validOps() != 0` |
|---|---|

#### public abstract int
**validOps**
()

Returns an [operation set](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/SelectionKey#opsets)
identifying this channel's supported operations. The bits that are set
in this integer value denote exactly the operations that are valid for
this channel. This method always returns the same value for a given
concrete channel class.

##### Returns

- The valid-operation set