MulticastOption Class

Reference

Definition

Namespace:: System.Net.Sockets

Assembly:: System.Net.Sockets.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: MulticastOption.cs

Source:: MulticastOption.cs

Source:: MulticastOption.cs

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.

Contains IPAddress values used to join and drop multicast groups.

public ref class MulticastOption

public class MulticastOption

type MulticastOption = class

Public Class MulticastOption

Inheritance: Object
MulticastOption

Examples

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.

#using <System.dll>

using namespace System;
using namespace System::Net;
using namespace System::Net::Sockets;
using namespace System::Text;

// This program shows how to use the MultiCastOption type. In particular,
// it shows how to use the MultiCastOption(IPAddress, IPAddress) constructor,
// You need to use this constructor, in the case of multihomed host (i.e.,
// a host with more than one network card). With the first parameter you
// specify the multicast group address, with the second you specify the
// local address of one of the network cards 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 from
// the command line.
//
public ref class TestMulticastOption
{
private:
   static IPAddress^ mcastAddress;
   static int mcastPort;
   static Socket^ mcastSocket;
   static MulticastOption^ mcastOption;

   static void MulticastOptionProperties()
   {
      Console::WriteLine( "Current multicast group is: {0}", mcastOption->Group );
      Console::WriteLine( "Current multicast local address is: {0}", mcastOption->LocalAddress );
   }


   static void StartMulticast()
   {
      try
      {
         mcastSocket = gcnew 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 = dynamic_cast<EndPoint^>(gcnew IPEndPoint( localIPAddr,mcastPort ));
         mcastSocket->Bind( localEP );
         
         // Define a MuticastOption object specifying the multicast group
         // address and the local IPAddress.
         // The multicast group address is the same one used by the server.
         mcastOption = gcnew MulticastOption( mcastAddress,localIPAddr );
         mcastSocket->SetSocketOption( SocketOptionLevel::IP, SocketOptionName::AddMembership, mcastOption );
         
      }
      catch ( Exception^ e ) 
      {
         Console::WriteLine( e );
      }

   }

   static void ReceiveBrodcastMessages()
   {
      bool done = false;
      array<Byte>^bytes = gcnew array<Byte>(100);
      IPEndPoint^ groupEP = gcnew IPEndPoint( mcastAddress,mcastPort );
      EndPoint^ remoteEP = dynamic_cast<EndPoint^>(gcnew IPEndPoint( IPAddress::Any,0 ));
      try
      {
         while (  !done )
         {
            Console::WriteLine( "Waiting for Multicast packets......." );
            Console::WriteLine( "Enter ^C to terminate." );
            mcastSocket->ReceiveFrom( bytes, remoteEP );
            Console::WriteLine( "Received broadcast from {0} :\n {1}\n", groupEP, Encoding::ASCII->GetString( bytes, 0, bytes->Length ) );
         }
         mcastSocket->Close();
      }
      catch ( Exception^ e ) 
      {
         Console::WriteLine( e );
      }

   }


public:
   static void Main()
   {
      
      // Initialize 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 values
      // used by the sender.
      mcastAddress = IPAddress::Parse( "224.168.100.2" );
      mcastPort = 11000;
      
      // Start a multicast group.
      StartMulticast();
      
      // Display multicast option properties.
      MulticastOptionProperties();
      
      // Receive brodcast messages.
      ReceiveBrodcastMessages();
   }

};

int main()
{
   TestMulticastOption::Main();
}


using System;
using System.Net;
using System.Net.Sockets;
using 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 command
// from the command line.
//
namespace Mssc.TransportProtocols.Utilities
{
    public class TestMulticastOption
    {
        private static IPAddress s_mcastAddress;
        private static int s_mcastPort;
        private static Socket s_mcastSocket;
        private static MulticastOption s_mcastOption;

        private static void MulticastOptionProperties()
        {
            Console.WriteLine("Current multicast group is: " + s_mcastOption.Group);
            Console.WriteLine("Current multicast local address is: " + s_mcastOption.LocalAddress);
        }

        private static void StartMulticast()
        {
            try
            {
                s_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, s_mcastPort);

                s_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.
                s_mcastOption = new MulticastOption(s_mcastAddress, localIPAddr);

                s_mcastSocket.SetSocketOption(SocketOptionLevel.IP,
                                            SocketOptionName.AddMembership,
                                            s_mcastOption);
            }

            catch (Exception e)
            {
                Console.WriteLine(e.ToString());
            }
        }

        private static void ReceiveBroadcastMessages()
        {
            bool done = false;
            byte[] bytes = new byte[100];
            IPEndPoint groupEP = new(s_mcastAddress, s_mcastPort);
            EndPoint remoteEP = (EndPoint)new IPEndPoint(IPAddress.Any, 0);

            try
            {
                while (!done)
                {
                    Console.WriteLine("Waiting for multicast packets.......");
                    Console.WriteLine("Enter ^C to terminate.");

                    s_mcastSocket.ReceiveFrom(bytes, ref remoteEP);

                    Console.WriteLine("Received broadcast from {0} :\n {1}\n",
                      groupEP.ToString(),
                      Encoding.ASCII.GetString(bytes, 0, bytes.Length));
                }

                s_mcastSocket.Close();
            }

            catch (Exception e)
            {
                Console.WriteLine(e.ToString());
            }
        }

        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.
            s_mcastAddress = IPAddress.Parse("224.168.100.2");
            s_mcastPort = 11000;

            // Start a multicast group.
            StartMulticast();

            // Display MulticastOption properties.
            MulticastOptionProperties();

            // Receive broadcast messages.
            ReceiveBroadcastMessages();
        }
    }
}

' 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 command 
' from the command line. 


Imports System.Net
Imports System.Net.Sockets
Imports System.Text

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


      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


      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


      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
    End Class

  End Module

End Namespace

#using <System.dll>

using namespace System;
using namespace System::Net::Sockets;
using namespace System::Net;
using namespace System::Text;

// This is an auxiliary program to be used in conjunction with a 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
// from the command line.
//
ref class TestMulticastOption
{
private:
   static IPAddress^ mcastAddress;
   static int mcastPort;
   static Socket^ mcastSocket;
   static void JoinMulticast()
   {
      try
      {
         
         // Create multicast socket.
         mcastSocket = gcnew Socket( AddressFamily::InterNetwork,SocketType::Dgram,ProtocolType::Udp );
         
         // Get the local IP address used by the listener and the sender to
         // exchange data in a multicast fashion.
         Console::Write( "\nEnter local IPAddress for sending multicast packets: " );
         IPAddress^ localIPAddr = IPAddress::Parse( Console::ReadLine() );
         
         // Create an IPEndPoint Object*.
         IPEndPoint^ IPlocal = gcnew IPEndPoint( localIPAddr,0 );
         
         // Bind this end point to the multicast socket.
         mcastSocket->Bind( IPlocal );
         
         // Define a MuticastOption Object* specifying the multicast group
         // address and the local IPAddress.
         // The multicast group address is the same one used by the listener.
         MulticastOption^ mcastOption;
         mcastOption = gcnew MulticastOption( mcastAddress,localIPAddr );
         mcastSocket->SetSocketOption( SocketOptionLevel::IP, SocketOptionName::AddMembership, mcastOption );
      }
      catch ( Exception^ e ) 
      {
         Console::WriteLine( "\n {0}", e );
      }

   }

   static void BrodcastMessage( String^ message )
   {
      IPEndPoint^ endPoint;
      try
      {
         
         //Send multicast packets to the listener.
         endPoint = gcnew IPEndPoint( mcastAddress,mcastPort );
         mcastSocket->SendTo( ASCIIEncoding::ASCII->GetBytes( message ), endPoint );
         Console::WriteLine( "Multicast data sent....." );
      }
      catch ( Exception^ e ) 
      {
         Console::WriteLine( "\n {0}", e );
      }

      mcastSocket->Close();
   }


public:
   static void main()
   {
      
      // Initialize 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 values
      // used by the sender.
      mcastAddress = IPAddress::Parse( "224.168.100.2" );
      mcastPort = 11000;
      
      // Join the listener multicast group.
      JoinMulticast();
      
      // Broadcast message to the listener.
      BrodcastMessage( "Hello multicast listener." );
   }

};

int main()
{
   TestMulticastOption::main();
}

using System;
using System.Net.Sockets;
using System.Net;
using System.Text;

// 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.
//
namespace Mssc.TransportProtocols.Utilities
{
    class TestMulticastOption2
    {
        static IPAddress s_mcastAddress;
        static int s_mcastPort;
        static Socket s_mcastSocket;

        static void JoinMulticastGroup()
        {
            try
            {
                // Create a multicast socket.
                s_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("\nEnter local IPAddress for sending multicast packets: ");
                IPAddress localIPAddr = IPAddress.Parse(Console.ReadLine());

                // Create an IPEndPoint object.
                IPEndPoint IPlocal = new IPEndPoint(localIPAddr, 0);

                // Bind this endpoint to the multicast socket.
                s_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.
                MulticastOption mcastOption;
                mcastOption = new MulticastOption(s_mcastAddress, localIPAddr);

                s_mcastSocket.SetSocketOption(SocketOptionLevel.IP,
                                            SocketOptionName.AddMembership,
                                            mcastOption);
            }
            catch (Exception e)
            {
                Console.WriteLine("\n" + e.ToString());
            }
        }

        static void BroadcastMessage(string message)
        {
            IPEndPoint endPoint;

            try
            {
                //Send multicast packets to the listener.
                endPoint = new IPEndPoint(s_mcastAddress, s_mcastPort);
                s_mcastSocket.SendTo(ASCIIEncoding.ASCII.GetBytes(message), endPoint);
                Console.WriteLine("Multicast data sent.....");
            }
            catch (Exception e)
            {
                Console.WriteLine("\n" + e.ToString());
            }

            s_mcastSocket.Close();
        }

        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.
            s_mcastAddress = IPAddress.Parse("224.168.100.2");
            s_mcastPort = 11000;

            // Join the listener multicast group.
            JoinMulticastGroup();

            // Broadcast the message to the listener.
            BroadcastMessage("Hello multicast listener.");
        }
    }
}

' 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.Net.Sockets
Imports System.Net
Imports System.Text

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


      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


      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
    End Class

  End Module

End Namespace

Remarks

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	SocketOptionLevel.Udp
socketOptionName	AddMembership
object	MulticastOption

Use DropMembership to drop a multicast group.

Constructors

MulticastOption(IPAddress, Int32)	Initializes a new instance of the MulticastOption class with the specified IP multicast group address and interface index.
MulticastOption(IPAddress, IPAddress)	Initializes a new instance of the MulticastOption class with the specified IP multicast group address and local IP address associated with a network interface.
MulticastOption(IPAddress)	Initializes a new version of the MulticastOption class for the specified IP multicast group.

Properties

Group	Gets or sets the IP address of a multicast group.
InterfaceIndex	Gets or sets the index of the interface that's used to send and receive multicast packets.
LocalAddress	Gets or sets the local address associated with a multicast group.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Jaa