MulticastOption Class
Assembly: System (in system.dll)
Use a MulticastOption to store the IPAddress of a multicast group you want to join or drop. Use the Socket.SetSocketOption method with the following parameters to join a multicast group.
| Parameter | Value |
|---|---|
| socketOptionLevel | |
| socketOptionName | |
| object | MulticastOption |
Use DropMembership to drop a multicast group.
The following examples join the default IP interface to an IP multicast group. They assume the IP multicast group address in the range 224.0.0.0 to 239.255.255.255.
' This is the listener example that shows how to use the MulticastOption class. ' In particular, it shows how to use the MulticastOption(IPAddress, IPAddress) ' constructor, which you need to use if you have a host with more than one ' network card. ' The first parameter specifies the multicast group address, and the second ' specifies the local address of the network card you want to use for the data ' exchange. ' You must run this program in conjunction with the sender program as ' follows: ' Open a console window and run the listener from the command line. ' In another console window run the sender. In both cases you must specify ' the local IPAddress to use. To obtain this address run the ipconfig comand ' from the command line. Imports System Imports System.Net Imports System.Net.Sockets Imports System.Text Imports Microsoft.VisualBasic Namespace Mssc.TransportProtocols.Utilities Module M_TestMulticastOption Public Class TestMulticastOption Private Shared mcastAddress As IPAddress Private Shared mcastPort As Integer Private Shared mcastSocket As Socket Private Shared mcastOption As MulticastOption Private Shared Sub MulticastOptionProperties() Console.WriteLine(("Current multicast group is: " + mcastOption.Group.ToString())) Console.WriteLine(("Current multicast local address is: " + mcastOption.LocalAddress.ToString())) End Sub 'MulticastOptionProperties Private Shared Sub StartMulticast() Try mcastSocket = New Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp) Console.Write("Enter the local IP address: ") Dim localIPAddr As IPAddress = IPAddress.Parse(Console.ReadLine()) 'IPAddress localIP = IPAddress.Any; Dim localEP As EndPoint = CType(New IPEndPoint(localIPAddr, mcastPort), EndPoint) mcastSocket.Bind(localEP) ' Define a MulticastOption object specifying the multicast group ' address and the local IPAddress. ' The multicast group address is the same as the address used by the server. mcastOption = New MulticastOption(mcastAddress, localIPAddr) mcastSocket.SetSocketOption(SocketOptionLevel.IP, SocketOptionName.AddMembership, mcastOption) Catch e As Exception Console.WriteLine(e.ToString()) End Try End Sub 'StartMulticast Private Shared Sub ReceiveBroadcastMessages() Dim done As Boolean = False Dim bytes() As Byte = New [Byte](99) {} Dim groupEP As New IPEndPoint(mcastAddress, mcastPort) Dim remoteEP As EndPoint = CType(New IPEndPoint(IPAddress.Any, 0), EndPoint) Try While Not done Console.WriteLine("Waiting for multicast packets.......") Console.WriteLine("Enter ^C to terminate.") mcastSocket.ReceiveFrom(bytes, remoteEP) Console.WriteLine("Received broadcast from {0} :" + ControlChars.Lf + " {1}" + ControlChars.Lf, groupEP.ToString(), Encoding.ASCII.GetString(bytes, 0, bytes.Length)) End While mcastSocket.Close() Catch e As Exception Console.WriteLine(e.ToString()) End Try End Sub 'ReceiveBrodcastMessages Public Shared Sub Main(ByVal args() As String) ' Initialize the multicast address group and multicast port. ' Both address and port are selected from the allowed sets as ' defined in the related RFC documents. These are the same ' as the values used by the sender. mcastAddress = IPAddress.Parse("224.168.100.2") mcastPort = 11000 ' Start a multicast group. StartMulticast() ' Display MulticastOption properties. MulticastOptionProperties() ' Receive broadcast messages. ReceiveBroadcastMessages() End Sub 'Main End Class 'TestMulticastOption End Module End Namespace
import System.* ;
import System.Net.* ;
import System.Net.Sockets.*;
import System.Text.*;
// This is the listener example that shows how to use the MulticastOption
// class.In particular, it shows how to use the MulticastOption
// (IPAddress, IPAddress)constructor, which you need to use if you have a host
// with more than one network card.
// The first parameter specifies the multicast group address, and the second
// specifies the local address of the network card you want to use for the data
// exchange.
// You must run this program in conjunction with the sender program as
// follows:
// Open a console window and run the listener from the command line.
// In another console window run the sender. In both cases you must specify
// the local IPAddress to use. To obtain this address run the ipconfig comand
// from the command line.
//
public class TestMulticastOption
{
private static IPAddress mcastAddress;
private static int mcastPort;
private static Socket mcastSocket;
private static MulticastOption mcastOption;
private static void MulticastOptionProperties()
{
Console.WriteLine(("Current multicast group is: "
+ mcastOption.get_Group()));
Console.WriteLine(("Current multicast local address is: "
+ mcastOption.get_LocalAddress()));
} //MulticastOptionProperties
private static void StartMulticast()
{
try {
mcastSocket = new Socket(AddressFamily.InterNetwork,
SocketType.Dgram, ProtocolType.Udp);
Console.Write("Enter the local IP address: ");
IPAddress localIPAddr = IPAddress.Parse(Console.ReadLine());
//IPAddress localIP = IPAddress.Any;
EndPoint localEP =
((EndPoint)(new IPEndPoint(localIPAddr, mcastPort)));
mcastSocket.Bind(localEP);
// Define a MulticastOption object specifying the multicast group
// address and the local IPAddress.
// The multicast group address is the same as the
// address used by the server.
mcastOption = new MulticastOption(mcastAddress, localIPAddr);
mcastSocket.SetSocketOption(SocketOptionLevel.IP,
SocketOptionName.AddMembership, mcastOption);
}
catch (System.Exception e) {
Console.WriteLine(e.ToString());
}
} //StartMulticast
private static void ReceiveBroadcastMessages()
{
boolean done = false;
System.Byte bytes[] = new System.Byte[100];
IPEndPoint groupEP = new IPEndPoint(mcastAddress, mcastPort);
EndPoint remoteEP = ((EndPoint)(new IPEndPoint(IPAddress.Any, 0)));
try {
while (!(done)) {
Console.WriteLine("Waiting for multicast packets.......");
Console.WriteLine("Enter ^C to terminate.");
mcastSocket.ReceiveFrom((ubyte[])bytes, remoteEP);
Console.WriteLine("Received broadcast from {0} :\n {1}\n",
groupEP.ToString(), Encoding.get_ASCII().GetString(
(ubyte[])bytes, 0, bytes.length));
}
mcastSocket.Close();
}
catch (System.Exception e) {
Console.WriteLine(e.ToString());
}
} //ReceiveBroadcastMessages
public static void main(String[] args)
{
// Initialize the multicast address group and multicast port.
// Both address and port are selected from the allowed sets as
// defined in the related RFC documents. These are the same
// as the values used by the sender.
mcastAddress = IPAddress.Parse("224.168.100.2");
mcastPort = 11000;
// Start a multicast group.
StartMulticast();
// Display MulticastOption properties.
MulticastOptionProperties();
// Receive broadcast messages.
ReceiveBroadcastMessages();
} //main
} //TestMulticastOption
' This sender example must be used in conjunction with the listener program. ' You must run this program as follows: ' Open a console window and run the listener from the command line. ' In another console window run the sender. In both cases you must specify ' the local IPAddress to use. To obtain this address, run the ipconfig command ' from the command line. ' Imports System Imports System.Net.Sockets Imports System.Net Imports System.Text Imports Microsoft.VisualBasic Namespace Mssc.TransportProtocols.Utilities Module M_TestMulticastOption Class TestMulticastOption Private Shared mcastAddress As IPAddress Private Shared mcastPort As Integer Private Shared mcastSocket As Socket Shared Sub JoinMulticastGroup() Try ' Create a multicast socket. mcastSocket = New Socket(AddressFamily.InterNetwork, SocketType.Dgram, ProtocolType.Udp) ' Get the local IP address used by the listener and the sender to ' exchange multicast messages. Console.Write(ControlChars.Lf + "Enter local IPAddress for sending multicast packets: ") Dim localIPAddr As IPAddress = IPAddress.Parse(Console.ReadLine()) ' Create an IPEndPoint object. Dim IPlocal As New IPEndPoint(localIPAddr, 0) ' Bind this endpoint to the multicast socket. mcastSocket.Bind(IPlocal) ' Define a MulticastOption object specifying the multicast group ' address and the local IP address. ' The multicast group address is the same as the address used by the listener. Dim mcastOption As MulticastOption mcastOption = New MulticastOption(mcastAddress, localIPAddr) mcastSocket.SetSocketOption(SocketOptionLevel.IP, SocketOptionName.AddMembership, mcastOption) Catch e As Exception Console.WriteLine((ControlChars.Lf + e.ToString())) End Try End Sub 'JoinMulticast Shared Sub BroadcastMessage(ByVal message As String) Dim endPoint As IPEndPoint Try 'Send multicast packets to the listener. endPoint = New IPEndPoint(mcastAddress, mcastPort) mcastSocket.SendTo(ASCIIEncoding.ASCII.GetBytes(message), endPoint) Console.WriteLine("Multicast data sent.....") Catch e As Exception Console.WriteLine((ControlChars.Lf + e.ToString())) End Try mcastSocket.Close() End Sub 'BrodcastMessage Public Shared Sub Main(ByVal args() As String) ' Initialize the multicast address group and multicast port. ' Both address and port are selected from the allowed sets as ' defined in the related RFC documents. These are the same as the ' values used by the sender. mcastAddress = IPAddress.Parse("224.168.100.2") mcastPort = 11000 ' Join the listener multicast group. JoinMulticastGroup() ' Broadcast the message to the listener. BroadcastMessage("Hello multicast listener.") End Sub 'Main End Class 'TestMulticastOption End Module End Namespace
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.