Класс SelectionKey

java.lang.Object

java.nio.channels.SelectionKey

Direct Known Subclasses:: AbstractSelectionKey

public abstract class SelectionKey extends Object

Токен, представляющий регистрацию SelectableChannel с Selector.

Ключ выбора создаётся каждый раз, когда канал регистрируется в селекторе. Ключ остаётся валидным до тех пор, пока его не отменят, вызвав метод cancel, не закроют его канал или селектор. Отмена ключа не удаляет его из селектора немедленно; вместо этого он добавляется в множество отменённых ключей селектора (множество отменённых ключей) для удаления во время следующей операции выбора. Валидность ключа можно проверить, вызвав метод isValid.

Ключ выбора содержит два набора операций, представленных целыми числами. Каждый бит набора операций обозначает категорию выбираемых операций, которые поддерживаются каналом ключа.

Набор интересов определяет категории операций, которые будут проверяться на готовность при следующем вызове одного из методов выбора селектора. Набор интересов инициализируется значением, заданным при создании ключа; его можно изменить позже с помощью метода interestOps(int).
Набор готовности определяет категории операций, для которых канал ключа был признан готовым селектором ключа. Набор готовности инициализируется нулём при создании ключа; он может быть обновлён селектором во время операции выбора, но не может быть обновлён напрямую.

То, что набор готовности ключа выбора указывает на готовность его канала для какой-либо категории операций, является подсказкой, но не гарантией, что операция в такой категории может быть выполнена потоком без блокировки потока. Набор готовности, скорее всего, будет точным сразу после завершения операции выбора. Он, скорее всего, станет неточным из-за внешних событий и операций ввода-вывода, которые вызываются по соответствующему каналу.

Этот класс определяет все известные биты набора операций, но то, какие именно биты поддерживаются конкретным каналом, зависит от типа канала. Каждый подкласс SelectableChannel определяет метод validOps(), который возвращает набор, идентифицирующий только те операции, которые поддерживаются каналом. Попытка установить или проверить бит набора операций, который не поддерживается каналом ключа, приведёт к соответствующему исключению во время выполнения.

Зачастую необходимо связать некоторые данные, специфичные для приложения, с ключом выбора, например, объект, представляющий состояние протокола более высокого уровня и обрабатывающий уведомления о готовности для реализации этого протокола. Поэтому ключи выбора поддерживают привязку одного произвольного объекта к ключу. Объект может быть привязан через метод attach и позже получен через метод attachment.

Ключи выбора безопасны для использования несколькими конкурирующими потоками. Операция выбора всегда будет использовать значение набора интересов, которое было текущим в момент начала операции.

Since:

1.4

See Also:

Краткое описание полей

Modifier and Type	Field	Description
`static final int`	`OP_ACCEPT`	Бит набора операций для операций accept сокета.
`static final int`	`OP_CONNECT`	Бит набора операций для операций connect сокета.
`static final int`	`OP_READ`	Бит набора операций для операций чтения.
`static final int`	`OP_WRITE`	Бит набора операций для операций записи.

Краткое описание конструкторов

SelectionKey()

Modifier	Constructor	Description
`protected`	Создаёт экземпляр этого класса.

Краткое описание методов

Modifier and Type	Method	Description
`final Object`	`attach(Object ob)`	Привязывает указанный объект к этому ключу.
`final Object`	`attachment()`	Возвращает текущую привязку.
`abstract void`	`cancel()`	Запрашивает отмену регистрации канала этого ключа в его селекторе.
`abstract SelectableChannel`	`channel()`	Возвращает канал, для которого был создан этот ключ.
`abstract int`	`interestOps()`	Возвращает набор интересов этого ключа.
`abstract SelectionKey`	`interestOps(int ops)`	Устанавливает набор интересов этого ключа в заданное значение.
`int`	`interestOpsAnd(int ops)`	Атомарно устанавливает набор интересов этого ключа в пересечение ("и") существующего набора интересов и заданного значения.
`int`	`interestOpsOr(int ops)`	Атомарно устанавливает набор интересов этого ключа в объединение ("или") существующего набора интересов и заданного значения.
`final boolean`	`isAcceptable()`	Проверяет, готов ли канал этого ключа принять новое подключение сокета.
`final boolean`	`isConnectable()`	Проверяет, завершил ли канал этого ключа или не смог завершить операцию подключения сокета.
`final boolean`	`isReadable()`	Проверяет, готов ли канал этого ключа для чтения.
`abstract boolean`	`isValid()`	Указывает, валиден ли этот ключ.
`final boolean`	`isWritable()`	Проверяет, готов ли канал этого ключа для записи.
`abstract int`	`readyOps()`	Возвращает набор операций готовности этого ключа.
`abstract Selector`	`selector()`	Возвращает селектор, для которого был создан этот ключ.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

OP_READ

public static final int OP_READ

Флаг набора операций для операций чтения.

Предположим, что множество интересов ключа выбора содержит OP_READ в начале операции выбора. Если селектор обнаруживает, что соответствующий канал готов к чтению, достиг конца потока, удалён удалённо для дальнейшего записи или имеет ошибку, ожидающую обработки, то он добавит OP_READ в набор готовых операций ключа.

См. также:

Значения константных полей

OP_WRITE

public static final int OP_WRITE

Флаг набора операций для операций записи.

Предположим, что множество интересов ключа выбора содержит OP_WRITE в начале операции выбора. Если селектор обнаруживает, что соответствующий канал готов к записи, удалён удалённо для дальнейшего чтения или имеет ошибку, ожидающую обработки, то он добавит OP_WRITE в набор готовых операций ключа.

См. также:

Значения константных полей

OP_CONNECT

public static final int OP_CONNECT

Флаг набора операций для операций подключения сокета.

Предположим, что множество интересов ключа выбора содержит OP_CONNECT в начале операции выбора. Если селектор обнаруживает, что соответствующий сокет-канал готов завершить последовательность подключения или имеет ошибку, ожидающую обработки, то он добавит OP_CONNECT в набор готовых операций ключа.

См. также:

Значения константных полей

OP_ACCEPT

public static final int OP_ACCEPT

Флаг набора операций для операций принятия сокета.

Предположим, что множество интересов ключа выбора содержит OP_ACCEPT в начале операции выбора. Если селектор обнаруживает, что соответствующий серверный сокет-канал готов принять другое подключение или имеет ошибку, ожидающую обработки, то он добавит OP_ACCEPT в набор готовых операций ключа.

См. также:

Значения константных полей

Подробное описание конструкторов

SelectionKey

protected SelectionKey()

Создаёт экземпляр этого класса.

Подробное описание методов

channel

public abstract SelectableChannel channel()

Возвращает канал, для которого был создан этот ключ. Этот метод будет продолжать возвращать канал даже после отмены ключа.

Возвращает:: Канал этого ключа

selector

public abstract Selector selector()

Возвращает селектор, для которого был создан этот ключ. Этот метод будет продолжать возвращать селектор даже после отмены ключа.

Возвращает:: Селектор этого ключа

isValid

public abstract boolean isValid()

Определяет, является ли этот ключ действительным.

Ключ действителен при создании и остаётся таким до тех пор, пока он не будет отменён, его канал не будет закрыт или его селектор не будет закрыт.

Возвращает:: true если и только если этот ключ действителен

cancel

public abstract void cancel()

Запрашивает отмену регистрации канала этого ключа с его селектором. После возврата ключ будет недействительным и будет добавлен в набор отменённых ключей его селектора. Ключ будет удалён из всех наборов ключей селектора во время следующей операции выбора.

Если этот ключ уже был отменён, вызов этого метода не оказывает никакого эффекта. После отмены ключ остаётся навсегда недействительным.

Этот метод можно вызывать в любое время. Он синхронизируется с набором отменённых ключей селектора и, следовательно, может временно заблокироваться, если он вызывается одновременно с операцией отмены или выбора, связанной с тем же селектором.

interestOps

public abstract int interestOps()

Возвращает множество интересов этого ключа.

Гарантируется, что возвращаемый набор будет содержать только флаги операций, допустимые для канала этого ключа.

Возвращает:: Множество интересов этого ключа
Использует:: CancelledKeyException - Если этот ключ был отменён

interestOps

public abstract SelectionKey interestOps(int ops)

Устанавливает множество интересов этого ключа на заданное значение.

Этот метод может вызываться в любое время. Если этот метод вызывается во время операции выбора, то он не оказывает никакого влияния на эту операцию; изменение множества интересов ключа будет видно следующей операцией выбора.

Параметры:: ops - Новое множество интересов
Возвращает:: Этот ключ выбора
Использует:: IllegalArgumentException - Если бит в наборе не соответствует операции, поддерживаемой каналом этого ключа, то есть, если (ops & ~channel().validOps()) != 0; CancelledKeyException - Если этот ключ был отменён

interestOpsOr

public int interestOpsOr(int ops)

Атомарно устанавливает множество интересов этого ключа в объединение по битовому ИЛИ (или) существующего множества интересов и заданного значения. Этот метод гарантированно является атомарным по отношению к другим одновременным вызовам этого метода или метода interestOpsAnd(int).

Требования к реализации:: По умолчанию реализация синхронизируется по этому ключу и вызывает interestOps() и interestOps(int) для получения и установки множества интересов этого ключа.
Параметры:: ops - Множество интересов для применения
Возвращает:: Предыдущее множество интересов
Использует:: IllegalArgumentException - Если бит в наборе не соответствует операции, поддерживаемой каналом этого ключа, то есть, если (ops & ~channel().validOps()) != 0; CancelledKeyException - Если этот ключ был отменён
С тех пор:: 11

interestOpsAnd

public int interestOpsAnd(int ops)

Атомарно устанавливает множество интересов этого ключа в пересечение по битовому И (и) существующего множества интересов и заданного значения. Этот метод гарантированно является атомарным по отношению к другим одновременным вызовам этого метода или метода interestOpsOr(int).

Примечание API:: В отличие от методов interestOps(int) и interestOpsOr(int), этот метод не выбрасывает IllegalArgumentException при вызове с битами в множестве интересов, которые не соответствуют операции, поддерживаемой каналом этого ключа. Это позволяет очищать биты операций в множестве интересов с помощью значений побитового дополнения, например, interestOpsAnd(~SelectionKey.OP_READ) удалит OP_READ из множества интересов, не повлияв на другие биты.
Требования к реализации:: По умолчанию реализация синхронизируется по этому ключу и вызывает interestOps() и interestOps(int) для получения и установки множества интересов этого ключа.
Параметры:: ops - Множество интересов для применения
Возвращает:: Предыдущее множество интересов
Использует:: CancelledKeyException - Если этот ключ был отменён
С тех пор:: 11

readyOps

public abstract int readyOps()

Возвращает набор готовых операций этого ключа.

Гарантируется, что возвращаемый набор будет содержать только биты операций, допустимые для канала этого ключа.

Возвращает:: Набор готовых операций этого ключа
Использует:: CancelledKeyException - Если этот ключ был отменён

isReadable

public final boolean isReadable()

Проверяет, готов ли канал этого ключа к чтению.

Вызов этого метода в форме k.isReadable() ведет себя точно так же, как выражение


 k.readyOps() & OP_READ != 0

Если канал этого ключа не поддерживает операции чтения, этот метод всегда возвращает false.

Возвращает:: true если и только если readyOps() & OP_READ не равно нулю
Использует:: CancelledKeyException - Если этот ключ был отменён

isWritable

public final boolean isWritable()

Проверяет, готов ли канал этого ключа к записи.

Вызов этого метода в форме k.isWritable() ведет себя точно так же, как выражение


 k.readyOps() & OP_WRITE != 0

Если канал этого ключа не поддерживает операции записи, этот метод всегда возвращает false.

Возвращает:: true если и только если readyOps() & OP_WRITE не равно нулю
Использует:: CancelledKeyException - Если этот ключ был отменён

isConnectable

public final boolean isConnectable()

Проверяет, завершил ли канал этого ключа операцию сокета или не смог её завершить.

Вызов этого метода в формате k.isConnectable() ведет себя точно так же, как выражение


 k.readyOps() & OP_CONNECT != 0

Если канал этого ключа не поддерживает операции сокета, то этот метод всегда возвращает false.

Возвращает:: true если и только если readyOps() & OP_CONNECT не равно нулю
Исключения:: CancelledKeyException - Если этот ключ был отменён

isAcceptable

public final boolean isAcceptable()

Проверяет, готов ли канал этого ключа принять новое подключение сокета.

Вызов этого метода в формате k.isAcceptable() ведет себя точно так же, как выражение


 k.readyOps() & OP_ACCEPT != 0

Если канал этого ключа не поддерживает операции приема подключения сокета, то этот метод всегда возвращает false.

Возвращает:: true если и только если readyOps() & OP_ACCEPT не равно нулю
Исключения:: CancelledKeyException - Если этот ключ был отменён

attach

public final Object attach(Object ob)

Прикрепляет заданный объект к этому ключу.

Прикреплённый объект может быть позже получен с помощью метода attachment. Одновременно может быть прикреплён только один объект; вызов этого метода приводит к удалению любого предыдущего прикрепления. Текущее прикрепление может быть удалено, прикрепив null.

Параметры:: ob - Объект, который нужно прикрепить; может быть null
Возвращает:: Предыдущий прикреплённый объект, если таковой был, в противном случае null

attachment

public final Object attachment()

Возвращает текущее прикрепление.

Возвращает:: Объект, в настоящее время прикреплённый к этому ключу, или null если прикрепления нет

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/SelectionKey.html