public abstract class MembershipKey extends Object
A membership key may represent a membership to receive all datagrams sent to the group, or it may be source-specific, meaning that it represents a membership that receives only datagrams from a specific source address. Whether or not a membership key is source-specific may be determined by invoking its sourceAddress method.
A membership key is valid upon creation and remains valid until the membership is dropped by invoking the drop method, or the channel is closed. The validity of the membership key may be tested by invoking its isValid method.
Where a membership key is not source-specific and the underlying operation system supports source filtering, then the block and unblock methods can be used to block or unblock multicast datagrams from particular source addresses.
| Modifier | Constructor | Description |
|---|---|---|
protected |
Initializes a new instance of this class. |
| Modifier and Type | Method | Description |
|---|---|---|
abstract MembershipKey |
block |
Block multicast datagrams from the given source address. |
abstract MulticastChannel |
channel() |
Returns the channel for which this membership key was created. |
abstract void |
drop() |
Drop membership. |
abstract InetAddress |
group() |
Returns the multicast group for which this membership key was created. |
abstract boolean |
isValid() |
Tells whether or not this membership is valid. |
abstract NetworkInterface |
networkInterface() |
Returns the network interface for which this membership key was created. |
abstract InetAddress |
sourceAddress() |
Returns the source address if this membership key is source-specific, or null if this membership is not source-specific. |
abstract MembershipKey |
unblock |
Unblock multicast datagrams from the given source address that was previously blocked using the block method. |
protected MembershipKey()
public abstract boolean isValid()
A multicast group membership is valid upon creation and remains valid until the membership is dropped by invoking the drop method, or the channel is closed.
true if this membership key is valid, false otherwisepublic abstract void drop()
If the membership key represents a membership to receive all datagrams then the membership is dropped and the channel will no longer receive any datagrams sent to the group. If the membership key is source-specific then the channel will no longer receive datagrams sent to the group from that source address.
After membership is dropped it may still be possible to receive datagrams sent to the group. This can arise when datagrams are waiting to be received in the socket's receive buffer. After membership is dropped then the channel may join the group again in which case a new membership key is returned.
Upon return, this membership object will be invalid. If the multicast group membership is already invalid then invoking this method has no effect. Once a multicast group membership is invalid, it remains invalid forever.
public abstract MembershipKey block(InetAddress source) throws IOException
If this membership key is not source-specific, and the underlying operating system supports source filtering, then this method blocks multicast datagrams from the given source address. If the given source address is already blocked then this method has no effect. After a source address is blocked it may still be possible to receive datagrams from that source. This can arise when datagrams are waiting to be received in the socket's receive buffer.
source - The source address to blockIllegalArgumentException - If the source parameter is not a unicast address or is not the same address type as the multicast groupIllegalStateException - If this membership key is source-specific or is no longer validUnsupportedOperationException - If the underlying operating system does not support source filteringIOException - If an I/O error occurspublic abstract MembershipKey unblock(InetAddress source)
block method.source - The source address to unblockIllegalStateException - If the given source address is not currently blocked or the membership key is no longer validpublic abstract MulticastChannel channel()
invalid.public abstract InetAddress group()
invalid.public abstract NetworkInterface networkInterface()
invalid.public abstract InetAddress sourceAddress()
null if this membership is not source-specific.null
© 1993, 2023, 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/21/docs/api/java.base/java/nio/channels/MembershipKey.html