ConnectionKeepAliveStrategy Interface Reference

Interface for deciding how long a connection can remain idle before being reused. More...

Inheritance diagram for ConnectionKeepAliveStrategy:

Description

Author

Sam Berlin

Version

Revision

Since

4.0

Notice

The following notice applies to the original API on which this API is based, and to its documentation. The documentation of this API has been revised from the original.

/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

Public Member Functions
long	getKeepAliveDuration (HttpResponse response, HttpContext context)
	Returns the duration of time which this connection can be safely kept idle. More...

Member Function Documentation

getKeepAliveDuration()

long getKeepAliveDuration	(	HttpResponse	response,
		HttpContext	context
	)

If the connection is left idle for longer than this period of time, it MUST not reused. A value of 0 or less may be returned to indicate that there is no suitable suggestion.

When coupled with a com.good.gd.apache.http.ConnectionReuseStrategy, if ConnectionReuseStrategy#keepAlive(HttpResponse, HttpContext) returns true, this allows you to control how long the reuse will last. If keepAlive returns false, this should have no meaningful impact

Parameters

response	The last response received over the connection.
context	the context in which the connection is being used.

Returns

the duration in ms for which it is safe to keep the connection idle, or <=0 if no suggested duration.

Implemented in DefaultConnectionKeepAliveStrategy.