Класс MembershipKey

java.lang.Object

java.nio.channels.MembershipKey

public abstract class MembershipKey extends Object

Токен, представляющий членство в группе интернет-мультиадресной рассылки (IP multicast).

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

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

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

С момента:

1.7

См. также:

MulticastChannel

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

MembershipKey()

Модификатор	Конструктор	Описание
`protected`	Инициализирует новый экземпляр этого класса.

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

Модификатор и тип	Метод	Описание
`abstract MembershipKey`	`block(InetAddress source)`	Блокирует мультиадресные дейтаграммы от указанного адреса источника.
`abstract MulticastChannel`	`channel()`	Возвращает канал, для которого был создан этот ключ членства.
`abstract void`	`drop()`	Удаляет членство.
`abstract InetAddress`	`group()`	Возвращает группу multicast, для которой был создан этот ключ членства.
`abstract boolean`	`isValid()`	Указывает, является ли данное членство действительным.
`abstract NetworkInterface`	`networkInterface()`	Возвращает сетевой интерфейс, для которого был создан этот ключ членства.
`abstract InetAddress`	`sourceAddress()`	Возвращает адрес источника, если этот ключ членства специфичен для источника, или `null`, если это членство не специфично для источника.
`abstract MembershipKey`	`unblock(InetAddress source)`	Разблокирует мультиадресные дейтаграммы от заданного адреса источника, который был ранее заблокирован с помощью метода `block`.

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

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

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

MembershipKey

protected MembershipKey()

Инициализирует новый экземпляр этого класса.

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

isValid

public abstract boolean isValid()

Указывает, является ли данное членство действительным.

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

Возвращает:: true , если этот ключ членства действителен, false в противном случае

drop

public abstract void drop()

Удаляет членство.

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

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

При возвращении этот объект членства будет invalid. Если членство в группе multicast уже недействительно, то вызов этого метода не повлияет. После того, как членство в группе multicast станет недействительным, оно остаётся недействительным навсегда.

block

public abstract MembershipKey block(InetAddress source) throws IOException

Блокирует мультиадресные дейтаграммы от указанного адреса источника.

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

Параметры:: source - Адрес источника, который нужно заблокировать
Возвращает:: Этот ключ членства
Исключения:: IllegalArgumentException - Если параметр source не является адресом одноадресной рассылки или не является тем же типом адреса, что и группа multicast; IllegalStateException - Если этот ключ членства специфичен для источника или больше недействителен; UnsupportedOperationException - Если операционная система не поддерживает фильтрацию по источнику; IOException - Если произошла ошибка ввода-вывода

unblock

public abstract MembershipKey unblock(InetAddress source)

Разблокирует мультиадресные дейтаграммы от заданного адреса источника, который был ранее заблокирован с помощью метода block.

Параметры:: source - Адрес источника, который нужно разблокировать
Возвращает:: Этот ключ членства
Исключения:: IllegalStateException - Если указанный адрес источника в настоящее время не заблокирован или ключ членства больше недействителен

channel

public abstract MulticastChannel channel()

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

Возвращает:: канал

group

public abstract InetAddress group()

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

Возвращает:: группу multicast

networkInterface

public abstract NetworkInterface networkInterface()

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

Возвращает:: сетевой интерфейс

sourceAddress

public abstract InetAddress sourceAddress()

Возвращает адрес источника, если этот ключ членства специфичен для источника, или null , если это членство не специфично для источника.

Возвращает:: Адрес источника, если этот ключ членства специфичен для источника, в противном случае 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/MembershipKey.html