Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
SocketAddress Class
Collapse the table of content
Expand the table of content

SocketAddress Class

Stores serialized information from EndPoint derived classes.


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

type SocketAddress =  class end

The SocketAddress type exposes the following members.

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

Public propertyFamilyGets the AddressFamily enumerated value of the current SocketAddress.
Public propertyItemGets or sets the specified index element in the underlying buffer.
Public propertySizeGets the underlying buffer size of the SocketAddress.

Public methodEqualsDetermines whether the specified Object is equal to the current SocketAddress 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 methodGetHashCodeServes as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. (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 methodToStringReturns information about the socket address. (Overrides Object.ToString().)

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.

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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

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

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