System.Net.SocketAddress Class

Summary

Stores serialized information from EndPoint derived classes.

C# Syntax:

public class SocketAddress

SocketAddress can be used to store a serialized IPEndPoint. The first byte of the underlying buffer is reserved for the AddressFamily enumerated value. The second byte is reserved for the size of the buffer. The third and fourth bytes are reserved for storing 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 SocketAddress.Family and SocketAddress.Size properties to get the AddressFamily value and the buffer size, respectively. To view any of this information as a string, use the SocketAddress.ToString method.

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 = 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());


    

System.Net Namespace

System.Net.SocketAddress Member List:

Public Constructors

ctor #1	Overloaded: .ctor(AddressFamily family) Creates a new instance of the SocketAddress class for the given address family.
ctor #2	Overloaded: .ctor(AddressFamily family, int size) Creates a new instance of the SocketAddress class using the specified address family and buffer size.

Public Properties

Family	Read-only Gets the AddressFamily enumerated value of the current SocketAddress.
Item	Read-write Gets or sets the specified index element in the underlying buffer.
Size	Read-only Gets the underlying buffer size of the SocketAddress.

Public Methods

Equals	Overridden: Determines whether two Object instances are equal.
GetHashCode	Overridden: Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
ToString	Overridden: Returns information about the socket address.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

• System.Object
• System.Net.SocketAddress

System.Net.SocketAddress Member Details

Summary

Creates a new instance of the SocketAddress class for the given address family.

C# Syntax:

public SocketAddress(    AddressFamily family );

family

An AddressFamily enumerated value.

This overload sets the underlying buffer size to 32 bytes.

Return to top

Summary

Creates a new instance of the SocketAddress class using the specified address family and buffer size.

C# Syntax:

public SocketAddress(    AddressFamily family,    int size );

family

An AddressFamily enumerated value.

size

The number of bytes to allocate for the underlying buffer.

Exceptions

Exception Type	Condition
ArgumentOutOfRangeException	The size parameter is less than 2. These two bytes are needed to store family and size.

Use this overload to create a new instance of the SocketAddress class with a particular underlying buffer size.

Return to top

Summary

Gets the AddressFamily enumerated value of the current SocketAddress.

C# Syntax:

public AddressFamily Family {get;}

This method gets the AddressFamily enumerated value representing the addressing scheme of the current SocketAddress. If you want to view the corresponding string representation of AddressFamily, use the SocketAddress.ToString method.

Return to top

Summary

Gets or sets the specified index element in the underlying buffer.

C# Syntax:

public byte this[int offset] {get; set;}

offset

The array index element of the desired information

Exceptions

Exception Type	Condition
IndexOutOfRangeException	The specified index does not exist in the buffer

This property gets or sets the specified byte position in the underlying buffer. The first byte of the underlying buffer is reserved for the AddressFamily enumerated value. The second byte is reserved for the size of the buffer. The third and fourth bytes are reserved for storing port number information. The next bytes are used to store the address.

Note Be sure to call SocketAddress.Size before referring to elements in the underlying buffer. Referring to an index that does not exist will cause the SocketAddress to throw an IndexOutOfRangeException.

Return to top

Summary

Gets the underlying buffer size of the SocketAddress.

C# Syntax:

public int Size {get;}

This property gets the underlying buffer size of the SocketAddress in bytes.

Return to top

Summary

Determines whether two Object instances are equal.

C# Syntax:

public override bool Equals(    object comparand );

comparand

Return to top

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~SocketAddress();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

C# Syntax:

public override int GetHashCode();

Return to top

Inherited
See base class member description: System.Object.GetType

C# Syntax:

public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top

Inherited
See base class member description: System.Object.MemberwiseClone

C# Syntax:

protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top

Summary

Returns information about the socket address.

C# Syntax:

public override string ToString();

Return Value:

A string containing information about the SocketAddress.

The SocketAddress.ToString method returns a string containing the AddressFamily enumerated value, the size of the underlying buffer of the SocketAddress structure, and the remaining contents of the buffer.

Return to top

Top of page