AbstractSelectableChannel (Java 2 Platform SE 5.0) (original) (raw)

java.nio.channels.spi

Class AbstractSelectableChannel

java.lang.Object java.nio.channels.spi.AbstractInterruptibleChannel java.nio.channels.SelectableChannel java.nio.channels.spi.AbstractSelectableChannel

All Implemented Interfaces:

Closeable, Channel, InterruptibleChannel

Direct Known Subclasses:

DatagramChannel, Pipe.SinkChannel, Pipe.SourceChannel, ServerSocketChannel, SocketChannel

public abstract class AbstractSelectableChannel

extends SelectableChannel

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 SelectableChannel 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.

Since:

1.4

AbstractSelectableChannel

protected AbstractSelectableChannel(SelectorProvider provider)

Initializes a new instance of this class.

provider

public final SelectorProvider provider()

Returns the provider that created this channel.

Specified by:

[provider](../../../../java/nio/channels/SelectableChannel.html#provider%28%29) in class [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html "class in java.nio.channels")

Returns:

The provider that created this channel

isRegistered

public final boolean isRegistered()

Description copied from class: [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html#isRegistered%28%29)

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.

Specified by:

[isRegistered](../../../../java/nio/channels/SelectableChannel.html#isRegistered%28%29) in class [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html "class in java.nio.channels")

Returns:

true if, and only if, this channel is registered

keyFor

public final SelectionKey keyFor(Selector sel)

Description copied from class: [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html#keyFor%28java.nio.channels.Selector%29)

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

Specified by:

[keyFor](../../../../java/nio/channels/SelectableChannel.html#keyFor%28java.nio.channels.Selector%29) in class [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html "class in java.nio.channels")

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

register

public final SelectionKey register(Selector sel, int ops, Object att) throws ClosedChannelException

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](../../../../java/nio/channels/spi/AbstractSelector.html#register%28java.nio.channels.spi.AbstractSelectableChannel, int, java.lang.Object%29) 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.

Specified by:

[register](../../../../java/nio/channels/SelectableChannel.html#register%28java.nio.channels.Selector, int, java.lang.Object%29) in class [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html "class in java.nio.channels")

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](../../../../java/nio/channels/ClosedChannelException.html "class in java.nio.channels") - If this channel is closed

implCloseChannel

protected final void implCloseChannel() throws IOException

Closes this channel.

This method, which is specified in the AbstractInterruptibleChannel class and is invoked by the close method, in turn invokes theimplCloseSelectableChannel method in order to perform the actual work of closing this channel. It then cancels all of this channel's keys.

Specified by:

[implCloseChannel](../../../../java/nio/channels/spi/AbstractInterruptibleChannel.html#implCloseChannel%28%29) in class [AbstractInterruptibleChannel](../../../../java/nio/channels/spi/AbstractInterruptibleChannel.html "class in java.nio.channels.spi")

Throws:

[IOException](../../../../java/io/IOException.html "class in java.io") - If an I/O error occurs while closing the channel

implCloseSelectableChannel

protected abstract void implCloseSelectableChannel() throws IOException

Closes this selectable channel.

This method is invoked by the 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.

Throws:

[IOException](../../../../java/io/IOException.html "class in java.io")

isBlocking

public final boolean isBlocking()

Description copied from class: [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html#isBlocking%28%29)

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.

Specified by:

[isBlocking](../../../../java/nio/channels/SelectableChannel.html#isBlocking%28%29) in class [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html "class in java.nio.channels")

Returns:

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

blockingLock

public final Object blockingLock()

Description copied from class: [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html#blockingLock%28%29)

Retrieves the object upon which the configureBlocking and [register](../../../../java/nio/channels/SelectableChannel.html#register%28java.nio.channels.Selector, int, java.lang.Object%29) 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.

Specified by:

[blockingLock](../../../../java/nio/channels/SelectableChannel.html#blockingLock%28%29) in class [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html "class in java.nio.channels")

Returns:

The blocking-mode lock object

configureBlocking

public final SelectableChannel configureBlocking(boolean block) throws IOException

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.

Specified by:

[configureBlocking](../../../../java/nio/channels/SelectableChannel.html#configureBlocking%28boolean%29) in class [SelectableChannel](../../../../java/nio/channels/SelectableChannel.html "class in java.nio.channels")

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](../../../../java/nio/channels/ClosedChannelException.html "class in java.nio.channels") - If this channel is closed

[IOException](../../../../java/io/IOException.html "class in java.io") - If an I/O error occurs

implConfigureBlocking

protected abstract void implConfigureBlocking(boolean block) throws IOException

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.

Throws:

[IOException](../../../../java/io/IOException.html "class in java.io") - If an I/O error occurs

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.