FileDocCategorySizeDatePackage
OperatedClientConnection.javaAPI DocAndroid 1.5 API6699Wed May 06 22:41:10 BST 2009org.apache.http.conn

OperatedClientConnection

public interface OperatedClientConnection implements HttpClientConnection, HttpInetConnection
A client-side connection that relies on outside logic to connect sockets to the appropriate hosts. It can be operated directly by an application, or through an {@link ClientConnectionOperator operator}.
author
Roland Weber
version
$Revision: 646087 $ $Date: 2008-04-08 14:36:46 -0700 (Tue, 08 Apr 2008) $
since
4.0

Fields Summary
Constructors Summary
Methods Summary
public java.net.SocketgetSocket()
Obtains the socket for this connection. The return value is well-defined only while the connection is open. It may change even while the connection is open, because of an {@link #update update}.

return
the socket for communicating with the {@link #getTargetHost target host}

public org.apache.http.HttpHostgetTargetHost()
Obtains the target host for this connection. If the connection is to a proxy but not tunnelled, this is the proxy. If the connection is tunnelled through a proxy, this is the target of the tunnel.
The return value is well-defined only while the connection is open. It may change even while the connection is open, because of an {@link #update update}.

return
the host to which this connection is opened

public booleanisSecure()
Indicates whether this connection is secure. The return value is well-defined only while the connection is open. It may change even while the connection is open, because of an {@link #update update}.

return
true if this connection is secure, false otherwise

public voidopenCompleted(boolean secure, org.apache.http.params.HttpParams params)
Signals that the connection has been successfully open. An attempt to call this method on an open connection will cause an exception.

param
secure true if this connection is secure, for example if an SSLSocket is used, or false if it is not secure
param
params parameters for this connection. The parameters will be used when creating dependent objects, for example to determine buffer sizes.

public voidopening(java.net.Socket sock, org.apache.http.HttpHost target)
Signals that this connection is in the process of being open.
By calling this method, you can provide the connection with the unconnected socket that will be connected before {@link #openCompleted} is called. This allows the connection to close that socket if {@link org.apache.http.HttpConnection#shutdown shutdown} is called before it is open. Closing the unconnected socket will interrupt a thread that is blocked on the connect. Otherwise, that thread will either time out on the connect, or it returns successfully and then opens this connection which was just shut down.
You also must call {@link #openCompleted} in order to complete the process

param
sock the unconnected socket which is about to be connected.
param
target the target host of this connection

public voidupdate(java.net.Socket sock, org.apache.http.HttpHost target, boolean secure, org.apache.http.params.HttpParams params)
Updates this connection. A connection can be updated only while it is open. Updates are used for example when a tunnel has been established, or when a TLS/SSL connection has been layered on top of a plain socket connection.
Note: Updating the connection will not close the previously used socket. It is the caller's responsibility to close that socket if it is no longer required.

param
sock the new socket for communicating with the target host, or null to continue using the old socket. If null is passed, helper objects that depend on the socket should be re-used. In that case, some changes in the parameters will not take effect.
param
target the new target host of this connection
param
secure true if this connection is now secure, false if it is not secure
param
params new parameters for this connection