AbstractSelectableChannel
abstract class AbstractSelectableChannel : SelectableChannel
kotlin.Any | |||
↳ | java.nio.channels.spi.AbstractInterruptibleChannel | ||
↳ | java.nio.channels.SelectableChannel | ||
↳ | java.nio.channels.spi.AbstractSelectableChannel |
Base implementation class for selectable channels.
This class defines methods that handle the mechanics of channel registration, deregistration, and closing. It maintains the current blocking mode of this channel as well as its current set of selection keys. It performs all of the synchronization required to implement the specification. Implementations of the abstract protected methods defined in this class need not synchronize against other threads that might be engaged in the same operations.
Summary
Protected constructors | |
---|---|
AbstractSelectableChannel(provider: SelectorProvider!) Initializes a new instance of this class. |
Public methods | |
---|---|
Any! | |
SelectableChannel! |
configureBlocking(block: Boolean) Adjusts this channel's blocking mode. |
Boolean | |
Boolean | |
SelectionKey! | |
SelectorProvider! |
provider() Returns the provider that created this channel. |
SelectionKey! |
Registers this channel with the given selector, returning a selection key. |
Protected methods | |
---|---|
Unit |
Closes this channel. |
abstract Unit |
Closes this selectable channel. |
abstract Unit |
implConfigureBlocking(block: Boolean) Adjusts this channel's blocking mode. |
Inherited functions | |
---|---|
Protected constructors
AbstractSelectableChannel
protected AbstractSelectableChannel(provider: SelectorProvider!)
Initializes a new instance of this class.
Parameters | |
---|---|
provider |
SelectorProvider!: The provider that created this channel |
Public methods
blockingLock
fun blockingLock(): Any!
Return | |
---|---|
Any! |
The blocking-mode lock object |
configureBlocking
fun configureBlocking(block: Boolean): SelectableChannel!
Adjusts this channel's blocking mode.
If the given blocking mode is different from the current blocking mode then this method invokes the implConfigureBlocking
method, while holding the appropriate locks, in order to change the mode.
Parameters | |
---|---|
block |
Boolean: If true then this channel will be placed in blocking mode; if false then it will be placed non-blocking mode |
Return | |
---|---|
SelectableChannel! |
This selectable channel |
Exceptions | |
---|---|
java.nio.channels.ClosedChannelException |
If this channel is closed |
java.nio.channels.IllegalBlockingModeException |
If block is true and this channel is registered with one or more selectors |
java.io.IOException |
If an I/O error occurs |
isBlocking
fun isBlocking(): Boolean
Return | |
---|---|
Boolean |
true if, and only if, this channel is in blocking mode |
isRegistered
fun isRegistered(): Boolean
Return | |
---|---|
Boolean |
true if, and only if, this channel is registered |
keyFor
fun keyFor(sel: Selector!): SelectionKey!
Parameters | |
---|---|
sel |
Selector!: The selector |
Return | |
---|---|
SelectionKey! |
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 |
provider
fun provider(): SelectorProvider!
Returns the provider that created this channel.
Return | |
---|---|
SelectorProvider! |
The provider that created this channel |
register
fun register(
sel: Selector!,
ops: Int,
att: Any!
): SelectionKey!
Registers this channel with the given selector, returning a selection key.
This method first verifies that this channel is open and that the given initial interest set is valid.
If this channel is already registered with the given selector then the selection key representing that registration is returned after setting its interest set to the given value.
Otherwise this channel has not yet been registered with the given selector, so the register
method of the selector is invoked while holding the appropriate locks. The resulting key is added to this channel's key set before being returned.
Parameters | |
---|---|
sel |
Selector!: The selector with which this channel is to be registered |
ops |
Int: The interest set for the resulting key |
att |
Any!: The attachment for the resulting key; may be null |
Return | |
---|---|
SelectionKey! |
A key representing the registration of this channel with the given selector |
Exceptions | |
---|---|
java.nio.channels.ClosedChannelException |
If this channel is closed |
java.nio.channels.ClosedSelectorException |
If the selector is closed |
java.nio.channels.IllegalBlockingModeException |
If this channel is in blocking mode |
java.nio.channels.IllegalSelectorException |
If this channel was not created by the same provider as the given selector |
java.nio.channels.CancelledKeyException |
If this channel is currently registered with the given selector but the corresponding key has already been cancelled |
java.lang.IllegalArgumentException |
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 |
Protected methods
implCloseChannel
protected fun implCloseChannel(): Unit
Closes this channel.
This method, which is specified in the AbstractInterruptibleChannel
class and is invoked by the java.nio.channels.Channel#close method, in turn invokes the implCloseSelectableChannel
method in order to perform the actual work of closing this channel. It then cancels all of this channel's keys.
Exceptions | |
---|---|
java.io.IOException |
If an I/O error occurs while closing the channel |
implCloseSelectableChannel
protected abstract fun implCloseSelectableChannel(): Unit
Closes this selectable channel.
This method is invoked by the java.nio.channels.Channel#close method in order to perform the actual work of closing the channel. This method is only invoked if the channel has not yet been closed, and it is never invoked more than once.
An implementation of this method must arrange for any other thread that is blocked in an I/O operation upon this channel to return immediately, either by throwing an exception or by returning normally.
Exceptions | |
---|---|
java.io.IOException |
If an I/O error occurs |
implConfigureBlocking
protected abstract fun implConfigureBlocking(block: Boolean): Unit
Adjusts this channel's blocking mode.
This method is invoked by the configureBlocking
method in order to perform the actual work of changing the blocking mode. This method is only invoked if the new mode is different from the current mode.
Parameters | |
---|---|
block |
Boolean: If true then this channel will be placed in blocking mode; if false then it will be placed non-blocking mode |
Exceptions | |
---|---|
java.io.IOException |
If an I/O error occurs |