SendTimeout Property

Gets and sets the number of milliseconds that a Tcp.Send method will block before throwing a SocketException.

[Visual Basic]
<DefaultValueAttribute()>
<DescriptionAttribute("Gets and Sets the number of milli-seconds that a socket Send() method will block before throwing a SocketException.")>
<CategoryAttribute("Socket Options")>
Public Property SendTimeout As Integer

[C#]
[DefaultValueAttribute()]
[DescriptionAttribute("Gets and Sets the number of milli-seconds that a socket Send() method will block before throwing a SocketException.")]
[CategoryAttribute("Socket Options")]
public int SendTimeout {get; set;}

[C++]
[DefaultValueAttribute()]
[DescriptionAttribute("Gets and Sets the number of milli-seconds that a socket Send() method will block before throwing a SocketException.")]
[CategoryAttribute("Socket Options")]
public: __property int get_SendTimeout();
public: __property void set_SendTimeout( 
   int value
);

[C++/CLI]
[DefaultValueAttribute()]
[DescriptionAttribute("Gets and Sets the number of milli-seconds that a socket Send() method will block before throwing a SocketException.")]
[CategoryAttribute("Socket Options")]
public:
property int SendTimeout {
   int get();
   void set (int value);
}

Return Type

The timeout (in milli-seconds) for completing a blocking Tcp.Send or SegmentedStream.Write. The default is 0, which indicates no timeout.

Remarks

The Tcp component will block (not execute further code on the main thread) until either the data is sent or until the method blocks for the time specified in Tcp.SendTimeout, at which point a SocketException is thrown. The default is 0, which indicates no timeout. Setting this property has no effect on asynchronous methods such as Tcp.BeginSend.

This property is useful for determining network failure while sending data. It is also useful for cases where sending data has to occur quickly or not at all, such as in an ASP script or when connecting and sending data to a series of sockets in a batch process.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows ME, Windows 2000, Windows XP, Windows Server 2003, Windows Vista

See Also

Tcp Class  | Tcp Members