HttpConnection Interface Reference

A generic HTTP connection, useful on client and server side. More...

Inheritance diagram for HttpConnection:

Description

Author

Oleg Kalnichevski

Version

Revision

548031

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
void	close () throws IOException
	Closes this connection gracefully. More...
boolean	isOpen ()
	Checks if this connection is open. More...
boolean	isStale ()
	Checks whether this connection has gone down. More...
void	setSocketTimeout (int timeout)
	Sets the socket timeout value. More...
int	getSocketTimeout ()
	Returns the socket timeout value. More...
void	shutdown () throws IOException
	Force-closes this connection. More...
HttpConnectionMetrics	getMetrics ()
	Returns a collection of connection metrcis. More...

Member Function Documentation

close()

void close

(

)

throws IOException

This method will attempt to flush the transmitter's internal buffer prior to closing the underlying socket. This method MUST NOT be called from a different thread to force shutdown of the connection. Use shutdown instead.

Implemented in DefaultClientConnection, and AbstractPooledConnAdapter.

isOpen()

boolean isOpen

(

)

Returns

true if it is open, false if it is closed.

Implemented in AbstractClientConnAdapter.

isStale()

boolean isStale

(

)

Network connections may get closed during some time of inactivity for several reasons. The next time a read is attempted on such a connection it will throw an IOException. This method tries to alleviate this inconvenience by trying to find out if a connection is still usable. Implementations may do that by attempting a read with a very small timeout. Thus this method may block for a small amount of time before returning a result. It is therefore an expensive operation.

Returns

true if attempts to use this connection are likely to succeed, or false if they are likely to fail and this connection should be closed

Implemented in AbstractClientConnAdapter.

setSocketTimeout()

void setSocketTimeout

(

int

timeout

)

Parameters

timeout

timeout value in milliseconds

Implemented in AbstractClientConnAdapter.

getSocketTimeout()

int getSocketTimeout

(

)

Returns

positive value in milliseconds if a timeout is set, 0 if timeout is disabled or -1 if timeout is undefined.

Implemented in AbstractClientConnAdapter.

shutdown()

void shutdown

(

)

throws IOException

This is the only method of a connection which may be called from a different thread to terminate the connection. This method will not attempt to flush the transmitter's internal buffer prior to closing the underlying socket.

Implemented in AbstractPooledConnAdapter, and DefaultClientConnection.

getMetrics()

HttpConnectionMetrics getMetrics

(

)

Returns

HttpConnectionMetrics

Implemented in AbstractClientConnAdapter.