Socket.RemoteEndPoint Property

Reference

Definition

Namespace:: System.Net.Sockets

Assemblies:: System.dll, System.Net.Sockets.dll

Assembly:: System.Net.Sockets.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: Socket.cs

Source:: Socket.cs

Source:: Socket.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.

Gets the remote endpoint.

public:
 property System::Net::EndPoint ^ RemoteEndPoint { System::Net::EndPoint ^ get(); };

public System.Net.EndPoint RemoteEndPoint { get; }

public System.Net.EndPoint? RemoteEndPoint { get; }

member this.RemoteEndPoint : System.Net.EndPoint

Public ReadOnly Property RemoteEndPoint As EndPoint

Property Value

EndPoint

The EndPoint with which the Socket is communicating.

Exceptions

SocketException

An error occurred when attempting to access the socket.

ObjectDisposedException

The Socket has been closed.

Examples

The following code example retrieves and displays the local and remote endpoints.

s->Connect(lep);

// Uses the RemoteEndPoint property.
Console::WriteLine("I am connected to {0} on port number {1}",
                   IPAddress::Parse((((IPEndPoint^)(s->RemoteEndPoint))->Address)->ToString()),
                   ((IPEndPoint^)(s->RemoteEndPoint))->Port.ToString());

// Uses the LocalEndPoint property.
Console::Write("My local IpAddress is : {0}\nI am connected on port number {1}",
               IPAddress::Parse((((IPEndPoint^)(s->LocalEndPoint))->Address)->ToString()),
               ((IPEndPoint^)(s->LocalEndPoint))->Port.ToString());

s.Connect(lep);

// Using the RemoteEndPoint property.
Console.WriteLine("I am connected to " + IPAddress.Parse(((IPEndPoint)s.RemoteEndPoint).Address.ToString()) + "on port number " + ((IPEndPoint)s.RemoteEndPoint).Port.ToString());

// Using the LocalEndPoint property.
Console.WriteLine("My local IpAddress is :" + IPAddress.Parse(((IPEndPoint)s.LocalEndPoint).Address.ToString()) + "I am connected on port number " + ((IPEndPoint)s.LocalEndPoint).Port.ToString());

s.Connect(lep)

' Using the RemoteEndPoint property.
Console.WriteLine("I am connected to ")
Console.WriteLine(IPAddress.Parse(CType(s.RemoteEndPoint, IPEndPoint).Address.ToString()))
Console.WriteLine("on port number ")
Console.WriteLine(CType(s.RemoteEndPoint, IPEndPoint).Port.ToString())

' Using the LocalEndPoint property.
Console.WriteLine("My local IpAddress is :")
Console.WriteLine(IPAddress.Parse(CType(s.LocalEndPoint, IPEndPoint).Address.ToString()))
Console.WriteLine("I am connected on port number ")
Console.WriteLine(CType(s.LocalEndPoint, IPEndPoint).Port.ToString())

Remarks

If you are using a connection-oriented protocol, the RemoteEndPoint property gets the EndPoint that contains the remote IP address and port number to which the Socket is connected. If you are using a connectionless protocol, RemoteEndPoint contains the default remote IP address and port number with which the Socket will communicate. You must cast this EndPoint to an IPEndPoint before retrieving any information. You can then call the IPEndPoint.Address method to retrieve the remote IPAddress, and the IPEndPoint.Port method to retrieve the remote port number.

The RemoteEndPoint is set after a call to either Accept or Connect. If you try to access this property earlier, RemoteEndPoint will throw a SocketException. If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Note

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in .NET Framework.

Applies to

Deila með