Socket.Ttl Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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.Net (in System.Net.dll)

Syntax

'Declaration
Public Property Ttl As Short
public short Ttl { get; set; }

Property Value

Type: System.Int16
The TTL value.

Exceptions

Exception Condition
ArgumentOutOfRangeException

The TTL value cannot be set to a value less than 0.

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.

ObjectDisposedException

The Socket has been closed.

Remarks

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.

Setting this property on a Transmission Control Protocol (TCP) socket will have no effect.

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.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.