A client-side connection with advanced connection logic. More...

Inheritance diagram for ManagedClientConnection:

Description

Instances are typically obtained from a connection manager.

Author: Roland Weber

Version

Revision: 672969

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
boolean	isSecure ()
	Indicates whether this connection is secure. More...

HttpRoute	getRoute ()
	Obtains the current route of this connection. More...

SSLSession	getSSLSession ()
	Obtains the SSL session of the underlying connection, if any. More...

void	open (HttpRoute route, HttpContext context, HttpParams params) throws IOException
	Opens this connection according to the given route. More...

void	tunnelTarget (boolean secure, HttpParams params) throws IOException
	Indicates that a tunnel to the target has been established. More...

void	tunnelProxy (HttpHost next, boolean secure, HttpParams params) throws IOException
	Indicates that a tunnel to an intermediate proxy has been established. More...

void	layerProtocol (HttpContext context, HttpParams params) throws IOException
	Layers a new protocol on top of a tunnelled connection. More...

void	markReusable ()
	Marks this connection as being in a reusable communication state. More...

void	unmarkReusable ()
	Marks this connection as not being in a reusable state. More...

boolean	isMarkedReusable ()
	Indicates whether this connection is in a reusable communication state. More...

void	setState (Object state)
	Assigns a state object to this connection. More...

Object	getState ()
	Returns the state object associated with this connection. More...

void	setIdleDuration (long duration, TimeUnit unit)
	Sets the duration that this connection can remain idle before it is reused. More...

Public Member Functions inherited from HttpClientConnection
boolean	isResponseAvailable (int timeout) throws IOException
	Checks if response data is available from the connection. More...

void	sendRequestHeader (HttpRequest request) throws HttpException, IOException
	Sends the request line and all headers over the connection. More...

void	sendRequestEntity (HttpEntityEnclosingRequest request) throws HttpException, IOException
	Sends the request entity over the connection. More...

HttpResponse	receiveResponseHeader () throws HttpException, IOException
	Receives the request line and headers of the next response available from this connection. More...

void	receiveResponseEntity (HttpResponse response) throws HttpException, IOException
	Receives the next response entity available from this connection and attaches it to an existing HttpResponse object. More...

void	flush () throws IOException
	Writes out all pending buffered data over the open connection. More...

Public Member Functions inherited from HttpConnection
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...

Public Member Functions inherited from ConnectionReleaseTrigger
void	releaseConnection () throws IOException
	Releases the connection with the option of keep-alive. More...

void	abortConnection () throws IOException
	Releases the connection without the option of keep-alive. More...

Member Function Documentation

◆ isSecure()

boolean isSecure ( )

The return value is well-defined only while the connection is open. It may change even while the connection is open.

Returns: true if this connection is secure, false otherwise

Implemented in AbstractClientConnAdapter.

◆ getRoute()

HttpRoute getRoute ( )

Returns: the route established so far, or null if not connected

Implemented in AbstractPooledConnAdapter.

◆ getSSLSession()

SSLSession getSSLSession ( )

If this connection is open, and the underlying socket is an javax.net.ssl.SSLSocket, the SSL session of that socket is obtained. This is a potentially blocking operation.
Note: Whether the underlying socket is an SSL socket can not necessarily be determined via isSecure. Plain sockets may be considered secure, for example if they are connected to a known host in the same network segment. On the other hand, SSL sockets may be considered insecure, for example depending on the chosen cipher suite.

Returns: the underlying SSL session if available, null otherwise

Implemented in AbstractClientConnAdapter.

◆ open()

void open	(	HttpRoute	route,
		HttpContext	context,
		HttpParams	params
	)		throws IOException

Parameters

route	the route along which to open. It will be opened to the first proxy if present, or directly to the target.
context	the context for opening this connection
params	the parameters for opening this connection

Exceptions

IOException in case of a problem

Implemented in AbstractPooledConnAdapter.

◆ tunnelTarget()

void tunnelTarget	(	boolean	secure,
		HttpParams	params
	)		throws IOException

The route is the one previously passed to open . Subsequently, layerProtocol can be called to layer the TLS/SSL protocol on top of the tunnelled connection.
Note: In HttpClient 3, a call to the corresponding method would automatically trigger the layering of the TLS/SSL protocol. This is not the case anymore, you can establish a tunnel without layering a new protocol over the connection.

Parameters

secure	`true` if the tunnel should be considered secure, `false` otherwise
params	the parameters for tunnelling this connection

Exceptions

IOException in case of a problem

Implemented in AbstractPooledConnAdapter.

◆ tunnelProxy()

void tunnelProxy	(	HttpHost	next,
		boolean	secure,
		HttpParams	params
	)		throws IOException

This is used exclusively for so-called proxy chains, where a request has to pass through multiple proxies before reaching the target. In that case, all proxies but the last need to be tunnelled when establishing the connection. Tunnelling of the last proxy to the target is optional and would be indicated via tunnelTarget.

Parameters

next	the proxy to which the tunnel was established. This is not the proxy through which the tunnel was established, but the new end point of the tunnel. The tunnel does not yet reach to the target, use tunnelTarget to indicate an end-to-end tunnel.
secure	`true` if the connection should be considered secure, `false` otherwise
params	the parameters for tunnelling this connection

Exceptions

IOException in case of a problem

Implemented in AbstractPooledConnAdapter.

◆ layerProtocol()

void layerProtocol	(	HttpContext	context,
		HttpParams	params
	)		throws IOException

This is typically used to create a TLS/SSL connection through a proxy. The route is the one previously passed to open . It is not guaranteed that the layered connection is secure .

Parameters

context	the context for layering on top of this connection
params	the parameters for layering on top of this connection

Exceptions

IOException in case of a problem

Implemented in AbstractPooledConnAdapter.

◆ markReusable()

void markReusable ( )

The checkpoints for reuseable communication states (in the absence of pipelining) are before sending a request and after receiving the response in it's entirety. The connection will automatically clear the checkpoint when used for communication. A call to this method indicates that the next checkpoint has been reached.
A reusable communication state is necessary but not sufficient for the connection to be reused. A route mismatch, the connection being closed, or other circumstances might prevent reuse.

Implemented in AbstractClientConnAdapter.

◆ unmarkReusable()

void unmarkReusable ( )

This can be used immediately before releasing this connection to prevent it's reuse. Reasons for preventing reuse include error conditions and the evaluation of a reuse strategy .
Note: It is not necessary to call here before writing to or reading from this connection. Communication attempts will automatically unmark the state as non-reusable. It can then be switched back using markReusable .

Implemented in AbstractClientConnAdapter.

◆ isMarkedReusable()

boolean isMarkedReusable ( )

See markReusable and unmarkReusable for details.

Returns: true if this connection is marked as being in a reusable communication state, false otherwise

Implemented in AbstractClientConnAdapter.

◆ setState()

void setState ( Object state )

Connection managers may make use of the connection state when allocating persistent connections.

Parameters

state The state object

Implemented in AbstractPooledConnAdapter.

◆ getState()

Object getState ( )

Returns: The state object

Implemented in AbstractPooledConnAdapter.

◆ setIdleDuration()

void setIdleDuration	(	long	duration,
		TimeUnit	unit
	)

The connection should not be used again if this time elapses. The idle duration must be reset after each request sent over this connection. The elapsed time starts counting when the connection is released, which is typically after the headers (and any response body, if present) is fully consumed.

Implemented in AbstractClientConnAdapter.

Description

Notice

Public Member Functions

Member Function Documentation

◆ isSecure()

◆ getRoute()

◆ getSSLSession()

◆ open()

◆ tunnelTarget()

◆ tunnelProxy()

◆ layerProtocol()

◆ markReusable()

◆ unmarkReusable()

◆ isMarkedReusable()

◆ setState()

◆ getState()

◆ setIdleDuration()