UdpAnySourceMulticastClient.BeginJoinGroup Method (AsyncCallback, Object)

.NET Framework (current version)
 
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 any group participant.

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.", 
	true)]
public IAsyncResult BeginJoinGroup(
	AsyncCallback callback,
	object state
)

Parameters

callback
Type: System.AsyncCallback

A callback method to invoke when the operation completes.

state
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
InvalidOperationException

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

ObjectDisposedException

The UdpAnySourceMulticastClient has been disposed.

SocketException

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

The BeginJoinGroup method binds a UDP multicast socket to a local port and joins a multicast group to allow datagrams to be received from any multicast group participant. The local port and multicast group address are specified in the UdpAnySourceMulticastClient 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
Silverlight
Available since 4.0
Windows Phone Silverlight
Available since 7.1
Return to top
Show: