ServicePoint.ConnectionLeaseTimeout Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the number of milliseconds after which an active ServicePoint connection is closed.
public:
property int ConnectionLeaseTimeout { int get(); void set(int value); };public int ConnectionLeaseTimeout { get; set; }member this.ConnectionLeaseTimeout : int with get, setPublic Property ConnectionLeaseTimeout As IntegerProperty Value
A Int32 that specifies the number of milliseconds that an active ServicePoint connection remains open. The default is -1, which allows an active ServicePoint connection to stay connected indefinitely. Set this property to 0 to force ServicePoint connections to close after servicing a request.
Exceptions
The value specified for a set operation is a negative number less than -1.
Examples
The following code example sets the value of this property.
#using <System.dll>
using namespace System;
using namespace System::Net;
using namespace System::Net::Sockets;
using namespace System::IO;
using namespace System::Threading;
namespace SystemNetExamples
{
public ref class ServicePointExample
{
public:
// Pass in the name of the Web page to retrieve.
static void PrintResponse(String^ page)
{
// Create the request.
HttpWebRequest^ request;
Uri^ uri;
try
{
uri = gcnew Uri(page);
}
catch (UriFormatException^ ex)
{
Console::WriteLine(ex->Message);
}
request = (HttpWebRequest^) WebRequest::Create(uri);
// Get the service point that handles the request's
// socket connection.
ServicePoint^ point = request->ServicePoint;
// Set the receive buffer size on the underlying socket.
point->ReceiveBufferSize = 2048;
// Set the connection lease timeout to infinite.
point->ConnectionLeaseTimeout = Timeout::Infinite;
// Send the request.
HttpWebResponse^ response =
(HttpWebResponse^) request->GetResponse();
Stream^ responseStream = response->GetResponseStream();
StreamReader^ streamReader =
gcnew StreamReader(responseStream);
try
{
// Display the response.
Console::WriteLine(streamReader->ReadToEnd());
responseStream->Close();
response->Close();
}
finally
{
streamReader->Close();
}
}
};
}
using System;
using System.Net;
using System.Net.Sockets;
using System.IO;
using System.Threading;
namespace Examples.System.Net
{
public class ServicePointExample
{
// Pass in the name of the Web page to retrieve.
public static void Main(string[] args)
{
string page;
if (args == null || args.Length == 0 || args[0].Length == 0)
{
page = "http://www.contoso.com/default.html";
}
else
{
page = args[0];
}
// Create the request.
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(page);
// Get the service point that handles the request's socket connection.
ServicePoint point = request.ServicePoint;
// Set the receive buffer size on the underlying socket.
point.ReceiveBufferSize = 2048;
// Set the connection lease timeout to infinite.
point.ConnectionLeaseTimeout = Timeout.Infinite;
// Send the request.
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
Stream responseStream = response.GetResponseStream();
StreamReader s = new StreamReader(responseStream);
// Display the response.
Console.WriteLine(s.ReadToEnd());
s.Close();
responseStream.Close();
response.Close();
}
}
}
Imports System.Net
Imports System.Net.Sockets
Imports System.IO
Imports System.Threading
Public Class ServicePointExample
' Pass in the name of the Web page to retrieve.
Public Shared Sub Main(ByVal args() As String)
Dim page As String
If args Is Nothing OrElse args.Length = 0 OrElse args(0).Length = 0 Then
page = "http://www.contoso.com/default.html"
Else
page = args(0)
End If
Dim request As HttpWebRequest = CType(WebRequest.Create(page), HttpWebRequest)
' Get the service point that handles the request's socket connection.
Dim point As ServicePoint = request.ServicePoint
' Set the receive buffer size on the underlying socket.
point.ReceiveBufferSize = 2048
' Set the connection lease timeout to infinite.
point.ConnectionLeaseTimeout = Timeout.Infinite
' Send the request.
Dim response As HttpWebResponse = CType(request.GetResponse(), HttpWebResponse)
Dim responseStream As Stream = response.GetResponseStream()
Dim s As New StreamReader(responseStream)
' Display the response.
Console.WriteLine(s.ReadToEnd())
responseStream.Close()
response.Close()
End Sub
End Class
Remarks
Caution
WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete, and you shouldn't use them for new development. Use HttpClient instead.
You can use this property to ensure that a ServicePoint object's active connections do not remain open indefinitely. This property is intended for scenarios where connections should be dropped and reestablished periodically, such as load balancing scenarios.
By default, when KeepAlive is true for a request, the MaxIdleTime property sets the time-out for closing ServicePoint connections due to inactivity. If the ServicePoint has active connections, MaxIdleTime has no effect and the connections remain open indefinitely.
When the ConnectionLeaseTimeout property is set to a value other than -1, and after the specified time elapses, an active ServicePoint connection is closed after servicing a request by setting KeepAlive to false in that request.
Setting this value affects all connections managed by the ServicePoint object.
