ClientConnectionOperator Interface Reference

Interface for opening connections . More...

Inheritance diagram for ClientConnectionOperator:

Description

This interface encapsulates the logic to create sockets and to open or update the connection with the new socket. Implementations will most likely make use of socket factories .
The methods in this interface allow the creation of plain and layered sockets. Creating a tunnelled connection through a proxy, however, is not within the scope of the operator.

Author

Roland Weber

Version

Revision

645850

Date

2008-04-08 04:08:52 -0700 (Tue, 08 Apr 2008)

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
OperatedClientConnection	createConnection ()
	Creates a new connection that can be operated. More...
void	openConnection (OperatedClientConnection conn, HttpHost target, InetAddress local, HttpContext context, HttpParams params) throws IOException
	Opens a connection to the given target host. More...
void	updateSecureConnection (OperatedClientConnection conn, HttpHost target, HttpContext context, HttpParams params) throws IOException
	Updates a connection with a layered secure connection. More...

Member Function Documentation

createConnection()

OperatedClientConnection createConnection

(

)

Returns

a new, unopened connection for use with this operator

Implemented in DefaultClientConnectionOperator.

openConnection()

void openConnection	(	OperatedClientConnection	conn,
		HttpHost	target,
		InetAddress	local,
		HttpContext	context,
		HttpParams	params
	)		throws IOException

Parameters

conn	the connection to open
target	the target host to connect to
local	the local address to route from, or null for the default
context	the context for the connection
params	the parameters for the connection

Exceptions

IOException

in case of a problem

Implemented in DefaultClientConnectionOperator.

updateSecureConnection()

void updateSecureConnection	(	OperatedClientConnection	conn,
		HttpHost	target,
		HttpContext	context,
		HttpParams	params
	)		throws IOException

The typical use of this method is to update a tunnelled plain connection (HTTP) to a secure TLS/SSL connection (HTTPS).

Parameters

conn	the open connection to update
target	the target host for the updated connection. The connection must already be open or tunnelled to the host and port, but the scheme of the target will be used to create a layered connection.
context	the context for the connection
params	the parameters for the updated connection

Exceptions

IOException

in case of a problem

Implemented in DefaultClientConnectionOperator.