Skip to content

Most visited

Recently visited

navigation

SelectionKey

public abstract class SelectionKey
extends Object

java.lang.Object
   ↳ java.nio.channels.SelectionKey
Known Direct Subclasses


A token representing the registration of a SelectableChannel with a Selector.

A selection key is created each time a channel is registered with a selector. A key remains valid until it is cancelled by invoking its cancel method, by closing its channel, or by closing its selector. Cancelling a key does not immediately remove it from its selector; it is instead added to the selector's cancelled-key set for removal during the next selection operation. The validity of a key may be tested by invoking its isValid method.

A selection key contains two operation sets represented as integer values. Each bit of an operation set denotes a category of selectable operations that are supported by the key's channel.

That a selection key's ready set indicates that its channel is ready for some operation category is a hint, but not a guarantee, that an operation in such a category may be performed by a thread without causing the thread to block. A ready set is most likely to be accurate immediately after the completion of a selection operation. It is likely to be made inaccurate by external events and by I/O operations that are invoked upon the corresponding channel.

This class defines all known operation-set bits, but precisely which bits are supported by a given channel depends upon the type of the channel. Each subclass of SelectableChannel defines an validOps() method which returns a set identifying just those operations that are supported by the channel. An attempt to set or test an operation-set bit that is not supported by a key's channel will result in an appropriate run-time exception.

It is often necessary to associate some application-specific data with a selection key, for example an object that represents the state of a higher-level protocol and handles readiness notifications in order to implement that protocol. Selection keys therefore support the attachment of a single arbitrary object to a key. An object can be attached via the attach method and then later retrieved via the attachment method.

Selection keys are safe for use by multiple concurrent threads. The operations of reading and writing the interest set will, in general, be synchronized with certain operations of the selector. Exactly how this synchronization is performed is implementation-dependent: In a naive implementation, reading or writing the interest set may block indefinitely if a selection operation is already in progress; in a high-performance implementation, reading or writing the interest set may block briefly, if at all. In any case, a selection operation will always use the interest-set value that was current at the moment that the operation began.

See also:

Summary

Constants

int OP_ACCEPT

Operation-set bit for socket-accept operations.

int OP_CONNECT

Operation-set bit for socket-connect operations.

int OP_READ

Operation-set bit for read operations.

int OP_WRITE

Operation-set bit for write operations.

Protected constructors

SelectionKey()

Constructs an instance of this class.

Public methods

final Object attach(Object ob)

Attaches the given object to this key.

final Object attachment()

Retrieves the current attachment.

abstract void cancel()

Requests that the registration of this key's channel with its selector be cancelled.

abstract SelectableChannel channel()

Returns the channel for which this key was created.

abstract int interestOps()

Retrieves this key's interest set.

abstract SelectionKey interestOps(int ops)

Sets this key's interest set to the given value.

final boolean isAcceptable()

Tests whether this key's channel is ready to accept a new socket connection.

final boolean isConnectable()

Tests whether this key's channel has either finished, or failed to finish, its socket-connection operation.

final boolean isReadable()

Tests whether this key's channel is ready for reading.

abstract boolean isValid()

Tells whether or not this key is valid.

final boolean isWritable()

Tests whether this key's channel is ready for writing.

abstract int readyOps()

Retrieves this key's ready-operation set.

abstract Selector selector()

Returns the selector for which this key was created.

Inherited methods

From class java.lang.Object

Constants

OP_ACCEPT

Added in API level 1
int OP_ACCEPT

Operation-set bit for socket-accept operations.

Suppose that a selection key's interest set contains OP_ACCEPT at the start of a selection operation. If the selector detects that the corresponding server-socket channel is ready to accept another connection, or has an error pending, then it will add OP_ACCEPT to the key's ready set and add the key to its selected-key set.

Constant Value: 16 (0x00000010)

OP_CONNECT

Added in API level 1
int OP_CONNECT

Operation-set bit for socket-connect operations.

Suppose that a selection key's interest set contains OP_CONNECT at the start of a selection operation. If the selector detects that the corresponding socket channel is ready to complete its connection sequence, or has an error pending, then it will add OP_CONNECT to the key's ready set and add the key to its selected-key set.

Constant Value: 8 (0x00000008)

OP_READ

Added in API level 1
int OP_READ

Operation-set bit for read operations.

Suppose that a selection key's interest set contains OP_READ at the start of a selection operation. If the selector detects that the corresponding channel is ready for reading, has reached end-of-stream, has been remotely shut down for further reading, or has an error pending, then it will add OP_READ to the key's ready-operation set and add the key to its selected-key set.

Constant Value: 1 (0x00000001)

OP_WRITE

Added in API level 1
int OP_WRITE

Operation-set bit for write operations.

Suppose that a selection key's interest set contains OP_WRITE at the start of a selection operation. If the selector detects that the corresponding channel is ready for writing, has been remotely shut down for further writing, or has an error pending, then it will add OP_WRITE to the key's ready set and add the key to its selected-key set.

Constant Value: 4 (0x00000004)

Protected constructors

SelectionKey

Added in API level 1
SelectionKey ()

Constructs an instance of this class.

Public methods

attach

Added in API level 1
Object attach (Object ob)

Attaches the given object to this key.

An attached object may later be retrieved via the attachment method. Only one object may be attached at a time; invoking this method causes any previous attachment to be discarded. The current attachment may be discarded by attaching null.

Parameters
ob Object: The object to be attached; may be null
Returns
Object The previously-attached object, if any, otherwise null

attachment

Added in API level 1
Object attachment ()

Retrieves the current attachment.

Returns
Object The object currently attached to this key, or null if there is no attachment

cancel

Added in API level 1
void cancel ()

Requests that the registration of this key's channel with its selector be cancelled. Upon return the key will be invalid and will have been added to its selector's cancelled-key set. The key will be removed from all of the selector's key sets during the next selection operation.

If this key has already been cancelled then invoking this method has no effect. Once cancelled, a key remains forever invalid.

This method may be invoked at any time. It synchronizes on the selector's cancelled-key set, and therefore may block briefly if invoked concurrently with a cancellation or selection operation involving the same selector.

channel

Added in API level 1
SelectableChannel channel ()

Returns the channel for which this key was created. This method will continue to return the channel even after the key is cancelled.

Returns
SelectableChannel This key's channel

interestOps

Added in API level 1
int interestOps ()

Retrieves this key's interest set.

It is guaranteed that the returned set will only contain operation bits that are valid for this key's channel.

This method may be invoked at any time. Whether or not it blocks, and for how long, is implementation-dependent.

Returns
int This key's interest set
Throws
CancelledKeyException If this key has been cancelled

interestOps

Added in API level 1
SelectionKey interestOps (int ops)

Sets this key's interest set to the given value.

This method may be invoked at any time. Whether or not it blocks, and for how long, is implementation-dependent.

Parameters
ops int: The new interest set
Returns
SelectionKey This selection key
Throws
IllegalArgumentException If a bit in the set does not correspond to an operation that is supported by this key's channel, that is, if (ops & ~channel().validOps()) != 0
CancelledKeyException If this key has been cancelled

isAcceptable

Added in API level 1
boolean isAcceptable ()

Tests whether this key's channel is ready to accept a new socket connection.

An invocation of this method of the form k.isAcceptable() behaves in exactly the same way as the expression

 k.readyOps() & OP_ACCEPT != 0

If this key's channel does not support socket-accept operations then this method always returns false.

Returns
boolean true if, and only if, readyOps() & OP_ACCEPT is nonzero
Throws
CancelledKeyException If this key has been cancelled

isConnectable

Added in API level 1
boolean isConnectable ()

Tests whether this key's channel has either finished, or failed to finish, its socket-connection operation.

An invocation of this method of the form k.isConnectable() behaves in exactly the same way as the expression

 k.readyOps() & OP_CONNECT != 0

If this key's channel does not support socket-connect operations then this method always returns false.

Returns
boolean true if, and only if, readyOps() & OP_CONNECT is nonzero
Throws
CancelledKeyException If this key has been cancelled

isReadable

Added in API level 1
boolean isReadable ()

Tests whether this key's channel is ready for reading.

An invocation of this method of the form k.isReadable() behaves in exactly the same way as the expression

 k.readyOps() & OP_READ != 0

If this key's channel does not support read operations then this method always returns false.

Returns
boolean true if, and only if, readyOps() & OP_READ is nonzero
Throws
CancelledKeyException If this key has been cancelled

isValid

Added in API level 1
boolean isValid ()

Tells whether or not this key is valid.

A key is valid upon creation and remains so until it is cancelled, its channel is closed, or its selector is closed.

Returns
boolean true if, and only if, this key is valid

isWritable

Added in API level 1
boolean isWritable ()

Tests whether this key's channel is ready for writing.

An invocation of this method of the form k.isWritable() behaves in exactly the same way as the expression

 k.readyOps() & OP_WRITE != 0

If this key's channel does not support write operations then this method always returns false.

Returns
boolean true if, and only if, readyOps() & OP_WRITE is nonzero
Throws
CancelledKeyException If this key has been cancelled

readyOps

Added in API level 1
int readyOps ()

Retrieves this key's ready-operation set.

It is guaranteed that the returned set will only contain operation bits that are valid for this key's channel.

Returns
int This key's ready-operation set
Throws
CancelledKeyException If this key has been cancelled

selector

Added in API level 1
Selector selector ()

Returns the selector for which this key was created. This method will continue to return the selector even after the key is cancelled.

Returns
Selector This key's selector
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.