UdpAnySourceMulticastClient.BlockSource(IPAddress) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Caution
This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.
Blocks a source so that multicast packets originating from it are no longer received.
public:
void BlockSource(System::Net::IPAddress ^ sourceAddress);
[System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)]
public void BlockSource (System.Net.IPAddress sourceAddress);
[<System.Obsolete("This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.", true)>]
member this.BlockSource : System.Net.IPAddress -> unit
Public Sub BlockSource (sourceAddress As IPAddress)
Parameters
- sourceAddress
- IPAddress
The address of the source to block.
- Attributes
Exceptions
The multicast group has not yet been joined.
The UdpAnySourceMulticastClient has been disposed.
An error occurred when attempting to access the socket.
Remarks
The BlockSource method blocks multicast packets originating from a specified source address from being received. The client must have completed a join to the multicast group.
The sourceAddress
parameter may be either an IPv6 or IPv4 address, but the sourceAddress
parameter must match the address family of the multicast group that the client joined.
The method specified in the callback
parameter is invoked when a packet has received.
If there is a socket failure while performing the block source operation, a SocketException is thrown. The error received is specified as a member of the SocketError enumeration.