MembershipKey Class

Definition

[Android.Runtime.Register("java/nio/channels/MembershipKey", ApiSince=26, DoNotGenerateAcw=true)]
public abstract class MembershipKey : Java.Lang.Object

[<Android.Runtime.Register("java/nio/channels/MembershipKey", ApiSince=26, DoNotGenerateAcw=true)>]
type MembershipKey = class
    inherit Object

Inheritance

Object

Object

MembershipKey

Attributes

RegisterAttribute

Remarks

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 <em>source-specific</em>, 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() sourceAddress method.

A membership key is valid upon creation and remains valid until the membership is dropped by invoking the #drop() drop method, or the channel is closed. The validity of the membership key may be tested by invoking its #isValid() isValid method.

Where a membership key is not source-specific and the underlying operation system supports source filtering, then the #block block and #unblock unblock methods can be used to block or unblock multicast datagrams from particular source addresses.

Added in 1.7.

Java documentation for java.nio.channels.MembershipKey.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to