IPEndPoint Class

Represents a network endpoint as an IP address and a port number.

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

[SerializableAttribute]
public class IPEndPoint : EndPoint

The IPEndPoint class contains the host and local or remote port information needed by an application to connect to a service on a host. By combining the host's IP address and port number of a service, the IPEndPoint class forms a connection point to a service.

// This example uses the IPEndPoint class and its members to display the home page  
// of the server selected by the user. 



using System;
using System.Text;
using System.IO;
using System.Net;
using System.Net.Sockets;
using System.Text.RegularExpressions;


namespace Mssc.Services.ConnectionManagement
{
  public class TestIPEndPoint
  {

    // The getPage method gets the server's home page content by  
    // recreating the server's endpoint from the original serialized endpoint. 
    // Then it creates a new socket and connects it to the endpoint. 
    private static string getPage(string server, SocketAddress socketAddress)
    {
      //Set up variables and string to write to the server.
      Encoding ASCII = Encoding.ASCII;
      string Get = "GET / HTTP/1.1\r\nHost: " + server + 
        "\r\nConnection: Close\r\n\r\n";
      Byte[] ByteGet = ASCII.GetBytes(Get);
      Byte[] RecvBytes = new Byte[256];
      String strRetPage = null;

      Socket socket = null;

      // Recreate the connection endpoint from the serialized information.
      IPEndPoint endpoint = new IPEndPoint(0,0);
      IPEndPoint clonedIPEndPoint = (IPEndPoint) endpoint.Create(socketAddress);
      Console.WriteLine("clonedIPEndPoint: " + clonedIPEndPoint.ToString());

      Console.WriteLine("Press any key to continue.");
      Console.ReadLine();

      try
      {
        // Create a socket object to establish a connection with the server.
        socket = 
          new Socket(endpoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);

        // Connect to the cloned end point.
        socket.Connect(clonedIPEndPoint);
      }
      catch(SocketException e) 
      {
        Console.WriteLine("Source : " + e.Source);
        Console.WriteLine("Message : " + e.Message);
      }
      catch(Exception e)
      {
        Console.WriteLine("Source : " + e.Source);
        Console.WriteLine("Message : " + e.Message);
      }

      if (socket == null)
        return ("Connection to cloned endpoint failed");

      // Send request to the server.
      socket.Send(ByteGet, ByteGet.Length, 0);  

      // Receive the server  home page content.
      Int32 bytes = socket.Receive(RecvBytes, RecvBytes.Length, 0);

      // Read the first 256 bytes.
      strRetPage = "Default HTML page on " + server + ":\r\n";
      strRetPage = strRetPage + ASCII.GetString(RecvBytes, 0, bytes);

      while (bytes > 0)
      {
        bytes = socket.Receive(RecvBytes, RecvBytes.Length, 0);
        strRetPage = strRetPage + ASCII.GetString(RecvBytes, 0, bytes);
      }

      socket.Close();

      return strRetPage;
    }

    // The serializeEndpoint method serializes the endpoint and returns the  
    // SocketAddress containing the serialized endpoint data. 
    private static SocketAddress serializeEndpoint(IPEndPoint endpoint)
    {

      // Serialize IPEndPoint details to a SocketAddress instance.
      SocketAddress socketAddress = endpoint.Serialize();

      // Display the serialized endpoint information.
      Console.WriteLine("Endpoint.Serialize() : " + socketAddress.ToString());

      Console.WriteLine("Socket.Family : " + socketAddress.Family);
      Console.WriteLine("Socket.Size : " + socketAddress.Size);

      Console.WriteLine("Press any key to continue.");
      Console.ReadLine();

      return socketAddress;
    }

    private static void displayEndpointInfo(IPEndPoint endpoint)
    {
      Console.WriteLine("Endpoint.Address : " + endpoint.Address);
      Console.WriteLine("Endpoint.AddressFamily : " + endpoint.AddressFamily);
      Console.WriteLine("Endpoint.Port : " + endpoint.Port);
      Console.WriteLine("Endpoint.ToString() : " + endpoint.ToString());

      Console.WriteLine("Press any key to continue.");
      Console.ReadLine();
    }

    // The serializeEndpoint method determines the server endpoint and then  
    // serializes it to obtain the related SocketAddress object. 
    // Note that in the for loop a temporary socket is created to ensure that  
    // the current IP address format matches the AddressFamily type. 
    // In fact, in the case of servers supporting both IPv4 and IPv6, an exception  
    // may arise if an IP address format does not match the address family type. 
    private static SocketAddress getSocketAddress(string server, int port)
    {
      Socket tempSocket = null;
      IPHostEntry host = null;
      SocketAddress serializedSocketAddress = null;

      try
      {
        // Get the object containing Internet host information.
        host = Dns.Resolve(server);

        // Obtain the IP address from the list of IP addresses associated with the server. 
        foreach(IPAddress address in host.AddressList)
        {
          IPEndPoint endpoint = new IPEndPoint(address, port);


          tempSocket = 
            new Socket(endpoint.AddressFamily, SocketType.Stream, ProtocolType.Tcp);

          tempSocket.Connect(endpoint);

          if(tempSocket.Connected)
          {
            // Display the endpoint information.
            displayEndpointInfo(endpoint);
            // Serialize the endpoint to obtain a SocketAddress object.
            serializedSocketAddress = serializeEndpoint(endpoint);
            break;
          }
          else 
            continue;
        }

        // Close the temporary socket.
        tempSocket.Close();
      }

      catch(SocketException e) 
      {
        Console.WriteLine("Source : " + e.Source);
        Console.WriteLine("Message : " + e.Message);
      }
      catch(Exception e)
      {
        Console.WriteLine("Source : " + e.Source);
        Console.WriteLine("Message : " + e.Message);
      }
      return serializedSocketAddress;

    }


    // The requestServerHomePage method obtains the server's home page and returns 
    // its content. 
    private static string requestServerHomePage(string server, int port) 
    {
      String strRetPage = null;

      // Get a socket address using the specified server and port.
      SocketAddress socketAddress = getSocketAddress(server, port);

      if (socketAddress == null)
        strRetPage = "Connection failed";
      else  
        // Obtain the server's home page content.
        strRetPage = getPage(server, socketAddress);

      return strRetPage;
    }

    // Show to the user how to use this program when wrong input parameters are entered. 
    private static void showUsage() 
    {
      Console.WriteLine("Enter the server name as follows:");
      Console.WriteLine("\tcs_ipendpoint servername");
    }

    // This is the program entry point. It allows the user to enter  
    // a server name that is used to locate its current homepage. 
    public static void Main(string[] args) 
    {
      string host= null;
      int port = 80;

      // Define a regular expression to parse user's input. 
      // This is a security check. It allows only 
      // alphanumeric input string between 2 to 40 character long.
      Regex rex = new Regex(@"^[a-zA-Z]\w{1,39}$");

      if (args.Length < 1)
        showUsage();
      else
      {
        string message = args[0];
        if ((rex.Match(message)).Success)
        {
          host = args[0];
          // Get the specified server home_page and display its content.
          string result = requestServerHomePage(host, port); 
          Console.WriteLine(result);
        }
        else
          Console.WriteLine("Input string format not allowed.");
      }

    }

  }
}
// This example uses the IPEndPoint class and its members to display the home page 
// of the server selected by the user.

#using <mscorlib.dll>
#using <System.dll>
using namespace System;
using namespace System::Text;
using namespace System::IO;
using namespace System::Net;
using namespace System::Net::Sockets;
using namespace System::Text::RegularExpressions;

// The getPage function gets the server's home page content by 
// recreating the server's endpoint from the original serialized endpoint.
// Then it creates a new socket and connects it to the endpoint.
String* getPage(String* server, SocketAddress* socketAddress)
{
   //Set up variables and string to write to the server.
   Encoding* ASCII = Encoding::ASCII;
   String* Get = String::Format( S"GET / HTTP/1.1\r\nHost: {0}\r\nConnection: Close\r\n\r\n", server );
   Byte ByteGet[] = ASCII->GetBytes(Get);
   Byte RecvBytes[] = new Byte[256];
   String* strRetPage = 0;

   Socket* socket = 0;

   // Recreate the connection endpoint from the serialized information.
   IPEndPoint* endpoint = new IPEndPoint((__int64)0,0);
   IPEndPoint* clonedIPEndPoint = dynamic_cast<IPEndPoint*> (endpoint->Create(socketAddress));
   Console::WriteLine(S"clonedIPEndPoint: {0}", clonedIPEndPoint);

   Console::WriteLine(S"Press any key to continue.");
   Console::ReadLine();

   try
   {
      // Create a socket object to establish a connection with the server.
      socket = 
         new Socket(endpoint->AddressFamily, SocketType::Stream, ProtocolType::Tcp);

      // Connect to the cloned end point.
      socket->Connect(clonedIPEndPoint);
   }
   catch(SocketException* e) 
   {
      Console::WriteLine(S"Source : {0}", e->Source);
      Console::WriteLine(S"Message : {0}", e->Message);
   }
   catch(Exception* e)
   {
      Console::WriteLine(S"Source : {0}", e->Source);
      Console::WriteLine(S"Message : {0}", e->Message);
   }

   if (socket == 0)
      return (S"Connection to cloned endpoint failed");

   // Send request to the server.
   socket->Send(ByteGet, ByteGet->Length,static_cast<SocketFlags>(0));  

   // Receive the server  home page content.
   Int32 bytes = socket->Receive(RecvBytes, RecvBytes->Length,static_cast<SocketFlags>(0));

   // Read the first 256 bytes.
   strRetPage = String::Format( S"Default HTML page on {0}:\r\n", server );
   strRetPage = String::Concat( strRetPage, ASCII->GetString(RecvBytes, 0, bytes) );

   while (bytes > 0)
   {
      bytes = socket->Receive(RecvBytes, RecvBytes->Length,static_cast<SocketFlags>(0));
      strRetPage = String::Concat( strRetPage, ASCII->GetString(RecvBytes, 0, bytes) );
   }

   socket->Close();

   return strRetPage;
}

// The serializeEndpoint function serializes the endpoint and returns the 
// SocketAddress containing the serialized endpoint data.
SocketAddress* serializeEndpoint(IPEndPoint* endpoint)
{

   // Serialize IPEndPoint details to a SocketAddress instance.
   SocketAddress* socketAddress = endpoint->Serialize();

   // Display the serialized endpoint information.
   Console::WriteLine(S"Endpoint.Serialize() : {0}", socketAddress);

   Console::WriteLine(S"Socket->Family : {0}", __box(socketAddress->Family));
   Console::WriteLine(S"Socket->Size : {0}", __box(socketAddress->Size));

   Console::WriteLine(S"Press any key to continue.");
   Console::ReadLine();

   return socketAddress;
}

void displayEndpointInfo(IPEndPoint* endpoint)
{
   Console::WriteLine(S"Endpoint->Address : {0}", endpoint->Address);
   Console::WriteLine(S"Endpoint->AddressFamily : {0}", __box(endpoint->AddressFamily));
   Console::WriteLine(S"Endpoint->Port : {0}", __box(endpoint->Port));
   Console::WriteLine(S"Endpoint.ToString() : {0}", endpoint);

   Console::WriteLine(S"Press any key to continue.");
   Console::ReadLine();
}

// The serializeEndpoint function determines the server endpoint and then 
// serializes it to obtain the related SocketAddress object.
// Note that in the for loop a temporary socket is created to ensure that 
// the current IP address format matches the AddressFamily type.
// In fact, in the case of servers supporting both IPv4 and IPv6, an exception 
// may arise if an IP address format does not match the address family type.
SocketAddress* getSocketAddress(String* server, int port)
{
   Socket* tempSocket = 0;
   IPHostEntry* host = 0;
   SocketAddress* serializedSocketAddress = 0;

   try
   {
      // Get the object containing Internet host information.
      host = Dns::Resolve(server);

      // Obtain the IP address from the list of IP addresses associated with the server.
      System::Collections::IEnumerator* myEnum = host->AddressList->GetEnumerator();
      while (myEnum->MoveNext())
      {
         IPAddress* address = __try_cast<IPAddress*>(myEnum->Current);
         IPEndPoint* endpoint = new IPEndPoint(address, port);


         tempSocket = 
            new Socket(endpoint->AddressFamily, SocketType::Stream, ProtocolType::Tcp);

         tempSocket->Connect(endpoint);

         if(tempSocket->Connected)
         {
            // Display the endpoint information.
            displayEndpointInfo(endpoint);
            // Serialize the endpoint to obtain a SocketAddress object.
            serializedSocketAddress = serializeEndpoint(endpoint);
            break;
         }
         else
            continue;
      }

      // Close the temporary socket.
      tempSocket->Close();
   }

   catch(SocketException* e) 
   {
      Console::WriteLine(S"Source : {0}", e->Source);
      Console::WriteLine(S"Message : {0}", e->Message);
   }
   catch(Exception* e)
   {
      Console::WriteLine(S"Source : {0}", e->Source);
      Console::WriteLine(S"Message : {0}", e->Message);
   }
   return serializedSocketAddress;

}

// The requestServerHomePage function obtains the server's home page and returns
// its content.
String* requestServerHomePage(String* server, int port) 
{
   String* strRetPage = 0;

   // Get a socket address using the specified server and port.
   SocketAddress* socketAddress = getSocketAddress(server, port);

   if (socketAddress == 0)
      strRetPage = S"Connection failed";
   else 
      // Obtain the server's home page content.
      strRetPage = getPage(server, socketAddress);

   return strRetPage;
}

// Show to the user how to use this program when wrong input parameters are entered.
void showUsage() 
{
   Console::WriteLine(S"Enter the server name as follows:");
   Console::WriteLine(S"\tcs_ipendpoint servername");
}

// This is the program entry point. It allows the user to enter 
// a server name that is used to locate its current homepage.
int main() 
{
   String* args[] = Environment::GetCommandLineArgs();

   String* host= 0;
   int port = 80;

   // Define a regular expression to parse user's input.
   // This is a security check. It allows only
   // alphanumeric input string between 2 to 40 character long.
   Regex* rex = new Regex(S"^[a-zA-Z]\\w{1,39}$");

   if (args->Length < 2)
      showUsage();
   else
   {
      String* message = args[1];
      if ((rex->Match(message))->Success)
      {
         host = args[1];
         // Get the specified server home_page and display its content.
         String* result = requestServerHomePage(host, port); 
         Console::WriteLine(result);
      }
      else
         Console::WriteLine(S"Input string format not allowed.");
   }

}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft