Apache HttpClient 4.5.14 · org.apache.http.conn.OperatedClientConnection

Method Summary

Modifier and Type	Method and Description
public Socket	Returns: the socket for communicating with the `target host` getSocket() Obtains the socket for this connection.
public HttpHost	Returns: the host to which this connection is opened getTargetHost() Obtains the target host for this connection.
public boolean	Returns: `true` if this connection is secure, `false` otherwise isSecure() Indicates whether this connection is secure.
public void	openCompleted(boolean `true` if this connection is secure, for example if an `SSLSocket` is used, or `false` if it is not secure secure, HttpParams parameters for this connection. The parameters will be used when creating dependent objects, for example to determine buffer sizes. params) Deprecated as a consequence of `HttpParams` being deprecated. Signals that the connection has been successfully open.
public void	opening(Socket the unconnected socket which is about to be connected. sock, HttpHost the target host of this connection target) Signals that this connection is in the process of being open.
public void	update(Socket 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. sock, HttpHost the new target host of this connection target, boolean `true` if this connection is now secure, `false` if it is not secure secure, HttpParams new parameters for this connection params) Deprecated as a consequence of `HttpParams` being deprecated. Updates this connection.

Inherited from org.apache.http.HttpClientConnection:: flush isResponseAvailable receiveResponseEntity receiveResponseHeader sendRequestEntity sendRequestHeader
Inherited from org.apache.http.HttpInetConnection:: getLocalAddress getLocalPort getRemoteAddress getRemotePort

Method Detail

getSocket back to summary

getSocket	back to summary
public Socket getSocket() 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 `update`. Returns:Socket the socket for communicating with the `target host`

public Socket getSocket()

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 update.

Returns:Socket: the socket for communicating with the target host

getTargetHost back to summary

getTargetHost	back to summary
public HttpHost getTargetHost() 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 `update`. Returns:HttpHost the host to which this connection is opened

public HttpHost getTargetHost()

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 update.

Returns:HttpHost: the host to which this connection is opened

isSecure back to summary

isSecure	back to summary
public boolean isSecure() 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 `update`. Returns:boolean `true` if this connection is secure, `false` otherwise

public boolean isSecure()

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 update.

Returns:boolean: true if this connection is secure, false otherwise

openCompleted back to summary

openCompleted	back to summary
public void openCompleted(boolean secure, HttpParams params) throws IOException Deprecated as a consequence of `HttpParams` being deprecated. See corresponding docs for further information. Signals that the connection has been successfully open. An attempt to call this method on an open connection will cause an exception. Parameters secure:boolean `true` if this connection is secure, for example if an `SSLSocket` is used, or `false` if it is not secure params:HttpParams parameters for this connection. The parameters will be used when creating dependent objects, for example to determine buffer sizes.

public void openCompleted(boolean secure, HttpParams params) throws IOException

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

Signals that the connection has been successfully open. An attempt to call this method on an open connection will cause an exception.

Parameters

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

opening back to summary

opening	back to summary
public void opening(Socket sock, HttpHost target) throws IOException Signals that this connection is in the process of being open. By calling this method, the connection can be re-initialized with a new Socket instance before `openCompleted` is called. This enabled the connection to close that socket if `shutdown` is called before it is fully open. Closing an 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. This method can be called multiple times if the connection is layered over another protocol Note This method will not close the previously used socket. It is the caller's responsibility to close that socket if it is no longer required. The caller must invoke `openCompleted` in order to complete the process. Parameters sock:Socket the unconnected socket which is about to be connected. target:HttpHost the target host of this connection

public void opening(Socket sock, HttpHost target) throws IOException

Signals that this connection is in the process of being open.

By calling this method, the connection can be re-initialized with a new Socket instance before openCompleted is called. This enabled the connection to close that socket if shutdown is called before it is fully open. Closing an 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.

This method can be called multiple times if the connection is layered over another protocol

Note

This method will not close the previously used socket. It is the caller's responsibility to close that socket if it is no longer required.

The caller must invoke openCompleted in order to complete the process.

Parameters

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

update back to summary

update	back to summary
public void update(Socket sock, HttpHost target, boolean secure, HttpParams params) throws IOException Deprecated as a consequence of `HttpParams` being deprecated. See corresponding docs for further information. 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. Parameters sock:Socket 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. target:HttpHost the new target host of this connection secure:boolean `true` if this connection is now secure, `false` if it is not secure params:HttpParams new parameters for this connection

public void update(Socket sock, HttpHost target, boolean secure, HttpParams params) throws IOException

Deprecated

as a consequence of HttpParams being deprecated. See corresponding docs for further information.

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.

Parameters

sock:Socket: 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.
target:HttpHost: the new target host of this connection
secure:boolean: true if this connection is now secure, false if it is not secure
params:HttpParams: new parameters for this connection

public Interface OperatedClientConnection

Method Summary

Method Detail