SocketAddress Class

Definition

Namespace:

System.Net

Assembly:

System.Net.Primitives.dll

Source:

SocketAddress.cs

Stores serialized information from EndPoint derived classes.

public ref class SocketAddress : IEquatable<System::Net::SocketAddress ^>

public class SocketAddress : IEquatable<System.Net.SocketAddress>

type SocketAddress = class
    interface IEquatable<SocketAddress>

Public Class SocketAddress
Implements IEquatable(Of SocketAddress)

Inheritance

Object

SocketAddress

Implements

IEquatable<SocketAddress>

Examples

The following example demonstrates how to use SocketAddress to serialize an instance of the EndPoint class. After serialization, the underlying byte buffer of the SocketAddress contains all of the IPEndPoint state information.

//Creates an IpEndPoint.
IPAddress^ ipAddress = Dns::Resolve( "www.contoso.com" )->AddressList[ 0 ];
IPEndPoint^ ipLocalEndPoint = gcnew IPEndPoint( ipAddress,11000 );

//Serializes the IPEndPoint.
SocketAddress^ socketAddress = ipLocalEndPoint->Serialize();

//Verifies that ipLocalEndPoint is now serialized by printing its contents.
Console::WriteLine( "Contents of the socketAddress are: {0}", socketAddress );
//Checks the Family property.
Console::WriteLine( "The address family of the socketAddress is: {0}", socketAddress->Family );
//Checks the underlying buffer size.
Console::WriteLine( "The size of the underlying buffer is: {0}", socketAddress->Size );

//Creates an IpEndPoint.
IPAddress ipAddress = Dns.Resolve("www.contoso.com").AddressList[0];
IPEndPoint ipLocalEndPoint = new IPEndPoint(ipAddress, 11000);

//Serializes the IPEndPoint.
SocketAddress socketAddress = ipLocalEndPoint.Serialize();

//Verifies that ipLocalEndPoint is now serialized by printing its contents.
Console.WriteLine("Contents of the socketAddress are: " + socketAddress.ToString());
//Checks the Family property.
Console.WriteLine("The address family of the socketAddress is: " + socketAddress.Family.ToString());
//Checks the underlying buffer size.
Console.WriteLine("The size of the underlying buffer is: " + socketAddress.Size.ToString());

   'Creates an IpEndPoint.
   Dim ipAddress As IPAddress = Dns.Resolve("www.contoso.com").AddressList(0)
   Dim ipLocalEndPoint As New IPEndPoint(ipAddress, 11000)
   
   'Serializes the IPEndPoint. 
   Dim socketAddress As SocketAddress = ipLocalEndPoint.Serialize()
   
   'Verifies that ipLocalEndPoint is now serialized by printing its contents.
   Console.WriteLine(("Contents of socketAddress are: " + socketAddress.ToString()))
   'Checks the Family property.
   Console.WriteLine(("The address family of socketAddress is: " + socketAddress.Family.ToString()))
   'Checks the underlying buffer size.
   Console.WriteLine(("The size of the underlying buffer is: " + socketAddress.Size.ToString()))
End Sub

Remarks

The first 2 bytes of the underlying buffer are reserved for the AddressFamily enumerated value. When the SocketAddress is used to store a serialized IPEndPoint, the third and fourth bytes are used to store port number information. The next bytes are used to store the IP address. You can access any information within this underlying byte buffer by referring to its index position; the byte buffer uses zero-based indexing. You can also use the Family and Size properties to get the AddressFamily value and the buffer size, respectively. To view any of this information as a string, use the ToString method.

Constructors

SocketAddress(AddressFamily, Int32)	Creates a new instance of the SocketAddress class using the specified address family and buffer size.
SocketAddress(AddressFamily)	Creates a new instance of the SocketAddress class for the given address family.

Properties

Buffer	Gets the underlying memory that can be passed to native OS calls.
Family	Gets the AddressFamily enumerated value of the current SocketAddress.
Item[Int32]	Gets or sets the specified index element in the underlying buffer.
Size	Gets the underlying buffer size of the SocketAddress.

Methods

Equals(Object)	Determines whether the specified Object is equal to the current Object.
Equals(SocketAddress)	Indicates whether the current object is equal to another object of the same type.
GetHashCode()	Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetMaximumAddressSize(AddressFamily)	Gets the maximum required buffer size for the given AddressFamily.
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 information about the socket address.