Socket.Ttl Property

 

Gets or sets a value that specifies the Time To Live (TTL) value of Internet Protocol (IP) packets sent by the Socket.

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

member Ttl : int16 with get, set

Property Value

Type: System.Int16

The TTL value.

Exception Condition
ArgumentOutOfRangeException

The TTL value can't be set to a negative number.

NotSupportedException

This property can be set only for sockets in the InterNetwork or InterNetworkV6 families.

SocketException

An error occurred when attempting to access the socket. This error is also returned when an attempt was made to set TTL to a value higher than 255.

ObjectDisposedException

The Socket has been closed.

The TTL value indicates the maximum number of routers the packet can traverse before the router discards the packet and an Internet Control Message Protocol (ICMP) "TTL exceeded" error message is returned to the sender.

The TTL value may be set to a value from 0 to 255. When this property is not set, the default TTL value for a socket is 32.

Setting this property on a Transmission Control Protocol (TCP) socket is ignored by the TCP/IP stack if a successful connection has been established using the socket.

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 in the MSDN library for a detailed description of the error.

The following code example demonstrates the use of the Ttl property.

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

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.1
Return to top
Show: