Export (0) Print
Expand All

IPEndPoint Class

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

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

'Declaration
<SerializableAttribute> _
Public Class IPEndPoint _
	Inherits EndPoint

The IPEndPoint type exposes the following members.

  NameDescription
Public methodIPEndPoint(Int64, Int32)Initializes a new instance of the IPEndPoint class with the specified address and port number.
Public methodIPEndPoint(IPAddress, Int32)Initializes a new instance of the IPEndPoint class with the specified address and port number.
Top

  NameDescription
Public propertyAddressGets or sets the IP address of the endpoint.
Public propertyAddressFamilyGets the Internet Protocol (IP) address family. (Overrides EndPoint.AddressFamily.)
Public propertyPortGets or sets the port number of the endpoint.
Top

  NameDescription
Public methodCreateCreates an endpoint from a socket address. (Overrides EndPoint.Create(SocketAddress).)
Public methodEqualsDetermines whether the specified Object is equal to the current IPEndPoint instance. (Overrides Object.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns a hash value for a IPEndPoint instance. (Overrides Object.GetHashCode.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSerializeSerializes endpoint information into a SocketAddress instance. (Overrides EndPoint.Serialize.)
Public methodToStringReturns the IP address and port number of the specified endpoint. (Overrides Object.ToString.)
Top

  NameDescription
Public fieldStatic memberMaxPortSpecifies the maximum value that can be assigned to the Port property. The MaxPort value is set to 0x0000FFFF. This field is read-only.
Public fieldStatic memberMinPortSpecifies the minimum value that can be assigned to the Port property. This field is read-only.
Top

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. 

Imports System
Imports System.Text
Imports System.IO
Imports System.Net
Imports System.Net.Sockets
Imports System.Text.RegularExpressions

Namespace Mssc.Services.ConnectionManagement
  Module M_TestIPEndPoint


    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 Shared Function getPage(ByVal server As String, ByVal socketAddress As SocketAddress) As String 
        'Set up variables and String to write to the server. 
        Dim ASCII As Encoding = Encoding.ASCII
        Dim [Get] As String = "GET / HTTP/1.1" + ControlChars.Cr + ControlChars.Lf + "Host: " + server + ControlChars.Cr + ControlChars.Lf + "Connection: Close" + ControlChars.Cr + ControlChars.Lf + ControlChars.Cr + ControlChars.Lf
        Dim ByteGet As [Byte]() = ASCII.GetBytes([Get])
        Dim RecvBytes(255) As [Byte]
        Dim strRetPage As [String] = Nothing 

        Dim socket As Socket = Nothing 

        ' Recreate the connection endpoint from the serialized information. 
        Dim endpoint As New IPEndPoint(0, 0)
        Dim clonedIPEndPoint As IPEndPoint = CType(endpoint.Create(socketAddress), IPEndPoint)
        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 e As SocketException
          Console.WriteLine(("Source : " + e.Source))
          Console.WriteLine(("Message : " + e.Message))
        Catch e As Exception
          Console.WriteLine(("Source : " + e.Source))
          Console.WriteLine(("Message : " + e.Message))
        End Try 

        If socket Is Nothing Then 
          Return "Connection to cloned endpoint failed" 
        End If 
        ' Send request to the server.
        socket.Send(ByteGet, ByteGet.Length, 0)

        ' Receive the server  home page content. 
        Dim bytes As Int32 = socket.Receive(RecvBytes, RecvBytes.Length, 0)

        ' Read the first 256 bytes.
        strRetPage = "Default HTML page on " + server + ":" + ControlChars.Cr + ControlChars.Lf
        strRetPage = strRetPage + ASCII.GetString(RecvBytes, 0, bytes)

        While bytes > 0
          bytes = socket.Receive(RecvBytes, RecvBytes.Length, 0)
          strRetPage = strRetPage + ASCII.GetString(RecvBytes, 0, bytes)
        End While

        socket.Close()

        Return strRetPage
      End Function 'getPage


      ' The serializeEndpoint method serializes the endpoint and returns the  
      ' SocketAddress containing the serialized endpoint data. 
      Private Shared Function serializeEndpoint(ByVal endpoint As IPEndPoint) As SocketAddress

        ' Serialize IPEndPoint details to a SocketAddress instance. 
        Dim socketAddress As SocketAddress = endpoint.Serialize()

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

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

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

        Return socketAddress
      End Function 'serializeEndpoint

      Private Shared Sub displayEndpointInfo(ByVal endpoint As IPEndPoint)
        Console.WriteLine("Endpoint Address : " + endpoint.Address.ToString())
        Console.WriteLine("Endpoint AddressFamily : " + endpoint.AddressFamily.ToString())
        Console.WriteLine("Endpoint Port : " + endpoint.Port.ToString())
        Console.WriteLine("Endpoint ToString() : " + endpoint.ToString())

        Console.WriteLine("Press any key to continue.")
        Console.ReadLine()
      End Sub 'displayEndpointInfo

      ' The following 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 Shared Function getSocketAddress(ByVal server As String, ByVal port As Integer) As SocketAddress
        Dim tempSocket As Socket = Nothing 
        Dim host As IPHostEntry = Nothing 
        Dim serializedSocketAddress As SocketAddress = Nothing 

        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. 
          Dim address As IPAddress
          For Each address In host.AddressList
            Dim endpoint As New IPEndPoint(address, port)


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

            tempSocket.Connect(endpoint)

            If tempSocket.Connected Then 
              ' Display the endpoint information.
              displayEndpointInfo(endpoint)
              ' Serialize the endpoint to obtain a SocketAddress object.
              serializedSocketAddress = serializeEndpoint(endpoint)
              Exit For 

            End If 

          Next address


          'Close the temporary socket.
          tempSocket.Close()

        Catch e As SocketException
          Console.WriteLine(("Source : " + e.Source))
          Console.WriteLine(("Message : " + e.Message))
        Catch e As Exception
          Console.WriteLine(("Source : " + e.Source))
          Console.WriteLine(("Message : " + e.Message))
        End Try 

        Return serializedSocketAddress

      End Function 'getSocketAddress



      ' The requestServerHomePage obtains the server's home page and returns 
      ' its content. 
      Private Shared Function requestServerHomePage(ByVal server As String, ByVal port As Integer) As String 
        Dim strRetPage As [String] = Nothing 

        ' Get a socket address using the specified server and port. 
        Dim socketAddress As SocketAddress = getSocketAddress(server, port)

        If socketAddress Is Nothing Then
          strRetPage = "Connection failed" 
          ' Obtain the server's home page content. 
        Else
          strRetPage = getPage(server, socketAddress)
        End If 
        Return strRetPage
      End Function 'requestServerHomePage


      ' Show to the user how to use this program when wrong input parameters are entered. 
      Private Shared Sub showusage()
        Console.WriteLine("Enter the server name as follows:")
        Console.WriteLine(ControlChars.Tab + "vb_ipendpoint servername")
      End Sub 'showusage

      ' This is the program entry point. It allows the user to enter  
      ' a server name that is used to locate its current homepage. 
      Public Shared Sub Main(ByVal args() As String)
        Dim host As String = Nothing 
        Dim port As Integer = 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. 
        Dim rex As New Regex("^[a-zA-Z]\w{1,39}$")

        If args.Length = 0 Then 
          ' Show how to use this program.
          showusage()
        Else
          host = args(0)
          If ((rex.Match(host)).Success) Then 
            ' Get the specified server home_page and display its content. 
            Dim result As String = requestServerHomePage(host, port)
            Console.WriteLine(result)
          Else
            Console.WriteLine("Input string format not allowed.")
          End If 
        End If 
      End Sub 'Main

    End Class 'TestIPEndPoint
  End Module 
End Namespace

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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