Share via


MembershipKey.Drop Method

Definition

Drop membership.

[Android.Runtime.Register("drop", "()V", "GetDropHandler", ApiSince=26)]
public abstract void Drop ();
[<Android.Runtime.Register("drop", "()V", "GetDropHandler", ApiSince=26)>]
abstract member Drop : unit -> unit
Attributes

Remarks

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 MulticastChannel#join join the group again in which case a new membership key is returned.

Upon return, this membership object will be #isValid() 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.

Java documentation for java.nio.channels.MembershipKey.drop().

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.

Applies to