jdk.nio.channels.MembershipKey
A token representing the membership of an Internet Protocol (IP) multicast group.
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.
A token representing the membership of an Internet Protocol (IP) multicast group. 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.
blockclj
(block this source)Block multicast datagrams from the given source address.
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 block - java.net.InetAddress
returns: This membership key - java.nio.channels.MembershipKey
throws: java.lang.IllegalArgumentException - If the source parameter is not a unicast address or is not the same address type as the multicast group
Block multicast datagrams from the given source address. 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 block - `java.net.InetAddress` returns: This membership key - `java.nio.channels.MembershipKey` throws: java.lang.IllegalArgumentException - If the source parameter is not a unicast address or is not the same address type as the multicast group
channelclj
(channel this)Returns the channel for which this membership key was created. This method will continue to return the channel even after the membership becomes invalid.
returns: the channel - java.nio.channels.MulticastChannel
Returns the channel for which this membership key was created. This method will continue to return the channel even after the membership becomes invalid. returns: the channel - `java.nio.channels.MulticastChannel`
dropclj
(drop this)Drop membership.
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.
Drop membership. 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.
groupclj
(group this)Returns the multicast group for which this membership key was created. This method will continue to return the group even after the membership becomes invalid.
returns: the multicast group - java.net.InetAddress
Returns the multicast group for which this membership key was created. This method will continue to return the group even after the membership becomes invalid. returns: the multicast group - `java.net.InetAddress`
network-interfaceclj
(network-interface this)Returns the network interface for which this membership key was created. This method will continue to return the network interface even after the membership becomes invalid.
returns: the network interface - java.net.NetworkInterface
Returns the network interface for which this membership key was created. This method will continue to return the network interface even after the membership becomes invalid. returns: the network interface - `java.net.NetworkInterface`
source-addressclj
(source-address this)Returns the source address if this membership key is source-specific, or null if this membership is not source-specific.
returns: The source address if this membership key is source-specific,
otherwise null - java.net.InetAddress
Returns the source address if this membership key is source-specific,
or null if this membership is not source-specific.
returns: The source address if this membership key is source-specific,
otherwise null - `java.net.InetAddress`unblockclj
(unblock this source)Unblock multicast datagrams from the given source address that was previously blocked using the block method.
source - The source address to unblock - java.net.InetAddress
returns: This membership key - java.nio.channels.MembershipKey
throws: java.lang.IllegalStateException - If the given source address is not currently blocked or the membership key is no longer valid
Unblock multicast datagrams from the given source address that was previously blocked using the block method. source - The source address to unblock - `java.net.InetAddress` returns: This membership key - `java.nio.channels.MembershipKey` throws: java.lang.IllegalStateException - If the given source address is not currently blocked or the membership key is no longer valid
valid?clj
(valid? this)Tells whether or not this membership is valid.
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.
returns: true if this membership key is valid, false
otherwise - boolean
Tells whether or not this membership is valid.
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.
returns: true if this membership key is valid, false
otherwise - `boolean`cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close