java.nio.channels

Class SelectableChannel

Implemented Interfaces:
AutoCloseable, Channel, Closeable, InterruptibleChannel
Known Direct Subclasses:
AbstractSelectableChannel

public abstract class SelectableChannel
extends AbstractInterruptibleChannel

Since:
1.4

Constructor Summary

SelectableChannel()
Initializes the channel.

Method Summary

abstract Object
blockingLock()
Returns the lock of this channel.
abstract SelectableChannel
configureBlocking(boolean block)
Adjusts this channel's blocking mode.
abstract boolean
isBlocking()
Tells whether this channel is blocking or not.
abstract boolean
isRegistered()
Tells whether or not this channel is currently registered with any selectors.
abstract SelectionKey
keyFor(Selector sel)
Retrieves the key representing the channel's registration with the given selector.
abstract SelectorProvider
provider()
Returns the provider that created this channel.
SelectionKey
register(Selector sel, int ops)
Registers this channel with the given selector, returning a selection key.
abstract SelectionKey
register(Selector sel, int ops, Object att)
Registers this channel with the given selector, returning a selection key.
abstract int
validOps()
Returns a set of valid operations on this channel.

Methods inherited from class java.nio.channels.spi.AbstractInterruptibleChannel

begin, close, end, implCloseChannel, isOpen

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SelectableChannel

protected SelectableChannel()
Initializes the channel.

Method Details

blockingLock

public abstract Object blockingLock()
Returns the lock of this channel.

configureBlocking

public abstract SelectableChannel configureBlocking(boolean block)
            throws IOException
Adjusts this channel's blocking mode.
Throws:
IllegalBlockingModeException - If block is true and this channel is registered with one or more selectors.
IOException - If an error occurs.

isBlocking

public abstract boolean isBlocking()
Tells whether this channel is blocking or not.

isRegistered

public abstract boolean isRegistered()
Tells whether or not this channel is currently registered with any selectors.

keyFor

public abstract SelectionKey keyFor(Selector sel)
Retrieves the key representing the channel's registration with the given selector.

provider

public abstract SelectorProvider provider()
Returns the provider that created this channel.

register

public final SelectionKey register(Selector sel,
                                   int ops)
            throws ClosedChannelException
Registers this channel with the given selector, returning a selection key.
Throws:
CancelledKeyException - If this channel is currently registered with the given selector but the corresponding key has already been cancelled
ClosedChannelException - If this channel is closed.
IllegalArgumentException - If a bit in ops does not correspond to an operation that is supported by this channel, that is, if set & ~validOps() != 0.
IllegalBlockingModeException - If block is true and this channel is registered with one or more selectors.
IllegalSelectorException - If this channel was not created by the same provider as the given selector.

register

public abstract SelectionKey register(Selector sel,
                                      int ops,
                                      Object att)
            throws ClosedChannelException
Registers this channel with the given selector, returning a selection key.
Throws:
CancelledKeyException - If this channel is currently registered with the given selector but the corresponding key has already been cancelled.
ClosedChannelException - If this channel is closed.
IllegalArgumentException - If a bit in ops does not correspond to an operation that is supported by this channel, that is, if set & ~validOps() != 0.
IllegalBlockingModeException - If block is true and this channel is registered with one or more selectors.
IllegalSelectorException - If this channel was not created by the same provider as the given selector.

validOps

public abstract int validOps()
Returns a set of valid operations on this channel.

SelectableChannel.java -- Copyright (C) 2002 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.