BeginJoinGroup Method

UdpSingleSourceMulticastClient.BeginJoinGroup Method (AsyncCallback, Object)

.NET Framework 4.6 and 4.5
Note: This API is now obsolete.

Binds the socket and begins a join operation to the multicast group to allow datagrams to be received from a single source address.

Namespace:   System.Net.Sockets
Assembly:  System.Net (in System.Net.dll)

[ObsoleteAttribute("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", 
public IAsyncResult BeginJoinGroup(
	AsyncCallback callback,
	object state


Type: System.AsyncCallback

A callback method to invoke when the operation completes.

Type: System.Object

Optional state information to pass to the callback method for this operation.

Return Value

Type: System.IAsyncResult

Returns IAsyncResult.

An IAsyncResult that references this operation.

Exception Condition

The multicast group has already been joined or a join operation is currently in progress.


The UdpSingleSourceMulticastClient has been disposed.


An error occurred when attempting to access the socket. See the Remarks section for more information.

The M:System.Net.Sockets.UdpSingleSourceMulticastClient.BeginJoinGroup method binds a UDP multicast socket to a local port and joins a multicast group to allow datagrams to be received from a single source address. The multicast group address, single source address, and local port to bind to are specified in the M:System.Net.Sockets.UdpSingleSourceMulticastClient.#ctor(System.Net.IPAddress,System.Int32) constructor.

The method specified in the callback parameter is invoked when the operation to join the multicast group has completed.

If required by the runtime, the BeginJoinGroup method also performs a policy check to verify that the client is allowed to access the multicast group. If the client is not allowed access, a SocketException is thrown with AccessDenied.

.NET Framework
Available since 4.5
Available since 4.0
Windows Phone Silverlight
Available since 7.1
Return to top
© 2015 Microsoft