You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
357 lines
18 KiB
357 lines
18 KiB
3 weeks ago
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
|
<!-- NewPage -->
|
||
|
<html lang="en">
|
||
|
<head>
|
||
|
<!-- Generated by javadoc (version 1.7.0_80) on Wed Nov 30 19:45:04 CET 2022 -->
|
||
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
<title>ClientConnectionManager (Apache HttpComponents Client 4.5.14 API)</title>
|
||
|
<meta name="date" content="2022-11-30">
|
||
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
||
|
</head>
|
||
|
<body>
|
||
|
<script type="text/javascript"><!--
|
||
|
if (location.href.indexOf('is-external=true') == -1) {
|
||
|
parent.document.title="ClientConnectionManager (Apache HttpComponents Client 4.5.14 API)";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
<noscript>
|
||
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
</noscript>
|
||
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
<div class="topNav"><a name="navbar_top">
|
||
|
<!-- -->
|
||
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="navList" title="Navigation">
|
||
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
||
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
<li class="navBarCell1Rev">Class</li>
|
||
|
<li><a href="class-use/ClientConnectionManager.html">Use</a></li>
|
||
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
||
|
<li><a href="../../../../index-all.html">Index</a></li>
|
||
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../../org/apache/http/conn/BasicManagedEntity.html" title="class in org.apache.http.conn"><span class="strong">Prev Class</span></a></li>
|
||
|
<li><a href="../../../../org/apache/http/conn/ClientConnectionManagerFactory.html" title="interface in org.apache.http.conn"><span class="strong">Next Class</span></a></li>
|
||
|
</ul>
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../../index.html?org/apache/http/conn/ClientConnectionManager.html" target="_top">Frames</a></li>
|
||
|
<li><a href="ClientConnectionManager.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_top">
|
||
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>Nested | </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method_summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="subNavList">
|
||
|
<li>Detail: </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method_detail">Method</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<a name="skip-navbar_top">
|
||
|
<!-- -->
|
||
|
</a></div>
|
||
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
<div class="header">
|
||
|
<div class="subTitle">org.apache.http.conn</div>
|
||
|
<h2 title="Interface ClientConnectionManager" class="title">Interface ClientConnectionManager</h2>
|
||
|
</div>
|
||
|
<div class="contentContainer">
|
||
|
<div class="description">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<dl>
|
||
|
<dt>All Known Implementing Classes:</dt>
|
||
|
<dd><a href="../../../../org/apache/http/impl/conn/BasicClientConnectionManager.html" title="class in org.apache.http.impl.conn">BasicClientConnectionManager</a>, <a href="../../../../org/apache/http/impl/conn/PoolingClientConnectionManager.html" title="class in org.apache.http.impl.conn">PoolingClientConnectionManager</a>, <a href="../../../../org/apache/http/impl/conn/SingleClientConnManager.html" title="class in org.apache.http.impl.conn">SingleClientConnManager</a>, <a href="../../../../org/apache/http/impl/conn/tsccm/ThreadSafeClientConnManager.html" title="class in org.apache.http.impl.conn.tsccm">ThreadSafeClientConnManager</a></dd>
|
||
|
</dl>
|
||
|
<hr>
|
||
|
<div class="block"><strong>Deprecated.</strong>
|
||
|
<div class="block"><i>(4.3) replaced by <a href="../../../../org/apache/http/conn/HttpClientConnectionManager.html" title="interface in org.apache.http.conn"><code>HttpClientConnectionManager</code></a>.</i></div>
|
||
|
</div>
|
||
|
<br>
|
||
|
<pre><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
|
||
|
public interface <span class="strong">ClientConnectionManager</span></pre>
|
||
|
<div class="block">Management interface for <a href="../../../../org/apache/http/conn/ManagedClientConnection.html" title="interface in org.apache.http.conn"><code>client connections</code></a>.
|
||
|
The purpose of an HTTP connection manager is to serve as a factory for new
|
||
|
HTTP connections, manage persistent connections and synchronize access to
|
||
|
persistent connections making sure that only one thread of execution can
|
||
|
have access to a connection at a time.
|
||
|
<p>
|
||
|
Implementations of this interface must be thread-safe. Access to shared
|
||
|
data must be synchronized as methods of this interface may be executed
|
||
|
from multiple threads.</div>
|
||
|
<dl><dt><span class="strong">Since:</span></dt>
|
||
|
<dd>4.0</dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="summary">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- ========== METHOD SUMMARY =========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="method_summary">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Method Summary</h3>
|
||
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
||
|
<tr>
|
||
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
<th class="colLast" scope="col">Method and Description</th>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code>void</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/conn/ClientConnectionManager.html#closeExpiredConnections()">closeExpiredConnections</a></strong>()</code>
|
||
|
<div class="block"><strong>Deprecated.</strong> </div>
|
||
|
<div class="block">Closes all expired connections in the pool.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code>void</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/conn/ClientConnectionManager.html#closeIdleConnections(long,%20java.util.concurrent.TimeUnit)">closeIdleConnections</a></strong>(long idletime,
|
||
|
<a href="https://docs.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code>
|
||
|
<div class="block"><strong>Deprecated.</strong> </div>
|
||
|
<div class="block">Closes idle connections in the pool.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code><a href="../../../../org/apache/http/conn/scheme/SchemeRegistry.html" title="class in org.apache.http.conn.scheme">SchemeRegistry</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/conn/ClientConnectionManager.html#getSchemeRegistry()">getSchemeRegistry</a></strong>()</code>
|
||
|
<div class="block"><strong>Deprecated.</strong> </div>
|
||
|
<div class="block">Obtains the scheme registry used by this manager.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code>void</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/conn/ClientConnectionManager.html#releaseConnection(org.apache.http.conn.ManagedClientConnection,%20long,%20java.util.concurrent.TimeUnit)">releaseConnection</a></strong>(<a href="../../../../org/apache/http/conn/ManagedClientConnection.html" title="interface in org.apache.http.conn">ManagedClientConnection</a> conn,
|
||
|
long validDuration,
|
||
|
<a href="https://docs.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</code>
|
||
|
<div class="block"><strong>Deprecated.</strong> </div>
|
||
|
<div class="block">Releases a connection for use by others.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code><a href="../../../../org/apache/http/conn/ClientConnectionRequest.html" title="interface in org.apache.http.conn">ClientConnectionRequest</a></code></td>
|
||
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/conn/ClientConnectionManager.html#requestConnection(org.apache.http.conn.routing.HttpRoute,%20java.lang.Object)">requestConnection</a></strong>(<a href="../../../../org/apache/http/conn/routing/HttpRoute.html" title="class in org.apache.http.conn.routing">HttpRoute</a> route,
|
||
|
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> state)</code>
|
||
|
<div class="block"><strong>Deprecated.</strong> </div>
|
||
|
<div class="block">Returns a new <a href="../../../../org/apache/http/conn/ClientConnectionRequest.html" title="interface in org.apache.http.conn"><code>ClientConnectionRequest</code></a>, from which a
|
||
|
<a href="../../../../org/apache/http/conn/ManagedClientConnection.html" title="interface in org.apache.http.conn"><code>ManagedClientConnection</code></a> can be obtained or the request can be
|
||
|
aborted.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code>void</code></td>
|
||
|
<td class="colLast"><code><strong><a href="../../../../org/apache/http/conn/ClientConnectionManager.html#shutdown()">shutdown</a></strong>()</code>
|
||
|
<div class="block"><strong>Deprecated.</strong> </div>
|
||
|
<div class="block">Shuts down this connection manager and releases allocated resources.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="details">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="method_detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Method Detail</h3>
|
||
|
<a name="getSchemeRegistry()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getSchemeRegistry</h4>
|
||
|
<pre><a href="../../../../org/apache/http/conn/scheme/SchemeRegistry.html" title="class in org.apache.http.conn.scheme">SchemeRegistry</a> getSchemeRegistry()</pre>
|
||
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
||
|
<div class="block">Obtains the scheme registry used by this manager.</div>
|
||
|
<dl><dt><span class="strong">Returns:</span></dt><dd>the scheme registry, never <code>null</code></dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="requestConnection(org.apache.http.conn.routing.HttpRoute, java.lang.Object)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>requestConnection</h4>
|
||
|
<pre><a href="../../../../org/apache/http/conn/ClientConnectionRequest.html" title="interface in org.apache.http.conn">ClientConnectionRequest</a> requestConnection(<a href="../../../../org/apache/http/conn/routing/HttpRoute.html" title="class in org.apache.http.conn.routing">HttpRoute</a> route,
|
||
|
<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> state)</pre>
|
||
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
||
|
<div class="block">Returns a new <a href="../../../../org/apache/http/conn/ClientConnectionRequest.html" title="interface in org.apache.http.conn"><code>ClientConnectionRequest</code></a>, from which a
|
||
|
<a href="../../../../org/apache/http/conn/ManagedClientConnection.html" title="interface in org.apache.http.conn"><code>ManagedClientConnection</code></a> can be obtained or the request can be
|
||
|
aborted.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="releaseConnection(org.apache.http.conn.ManagedClientConnection, long, java.util.concurrent.TimeUnit)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>releaseConnection</h4>
|
||
|
<pre>void releaseConnection(<a href="../../../../org/apache/http/conn/ManagedClientConnection.html" title="interface in org.apache.http.conn">ManagedClientConnection</a> conn,
|
||
|
long validDuration,
|
||
|
<a href="https://docs.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre>
|
||
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
||
|
<div class="block">Releases a connection for use by others.
|
||
|
You may optionally specify how long the connection is valid
|
||
|
to be reused. Values <= 0 are considered to be valid forever.
|
||
|
If the connection is not marked as reusable, the connection will
|
||
|
not be reused regardless of the valid duration.
|
||
|
|
||
|
If the connection has been released before,
|
||
|
the call will be ignored.</div>
|
||
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>conn</code> - the connection to release</dd><dd><code>validDuration</code> - the duration of time this connection is valid for reuse</dd><dd><code>timeUnit</code> - the unit of time validDuration is measured in</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/http/conn/ClientConnectionManager.html#closeExpiredConnections()"><code>closeExpiredConnections()</code></a></dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="closeIdleConnections(long, java.util.concurrent.TimeUnit)">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>closeIdleConnections</h4>
|
||
|
<pre>void closeIdleConnections(long idletime,
|
||
|
<a href="https://docs.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> timeUnit)</pre>
|
||
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
||
|
<div class="block">Closes idle connections in the pool.
|
||
|
Open connections in the pool that have not been used for the
|
||
|
timespan given by the argument will be closed.
|
||
|
Currently allocated connections are not subject to this method.
|
||
|
Times will be checked with milliseconds precision
|
||
|
|
||
|
All expired connections will also be closed.</div>
|
||
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>idletime</code> - the idle time of connections to be closed</dd><dd><code>timeUnit</code> - the unit for the <code>idletime</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/http/conn/ClientConnectionManager.html#closeExpiredConnections()"><code>closeExpiredConnections()</code></a></dd></dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="closeExpiredConnections()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>closeExpiredConnections</h4>
|
||
|
<pre>void closeExpiredConnections()</pre>
|
||
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
||
|
<div class="block">Closes all expired connections in the pool.
|
||
|
Open connections in the pool that have not been used for
|
||
|
the timespan defined when the connection was released will be closed.
|
||
|
Currently allocated connections are not subject to this method.
|
||
|
Times will be checked with milliseconds precision.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="shutdown()">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>shutdown</h4>
|
||
|
<pre>void shutdown()</pre>
|
||
|
<div class="block"><span class="strong">Deprecated.</span> </div>
|
||
|
<div class="block">Shuts down this connection manager and releases allocated resources.
|
||
|
This includes closing all connections, whether they are currently
|
||
|
used or not.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
</div>
|
||
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
|
<div class="bottomNav"><a name="navbar_bottom">
|
||
|
<!-- -->
|
||
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="navList" title="Navigation">
|
||
|
<li><a href="../../../../overview-summary.html">Overview</a></li>
|
||
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
<li class="navBarCell1Rev">Class</li>
|
||
|
<li><a href="class-use/ClientConnectionManager.html">Use</a></li>
|
||
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
||
|
<li><a href="../../../../index-all.html">Index</a></li>
|
||
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../../org/apache/http/conn/BasicManagedEntity.html" title="class in org.apache.http.conn"><span class="strong">Prev Class</span></a></li>
|
||
|
<li><a href="../../../../org/apache/http/conn/ClientConnectionManagerFactory.html" title="interface in org.apache.http.conn"><span class="strong">Next Class</span></a></li>
|
||
|
</ul>
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../../index.html?org/apache/http/conn/ClientConnectionManager.html" target="_top">Frames</a></li>
|
||
|
<li><a href="ClientConnectionManager.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_bottom">
|
||
|
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>Nested | </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method_summary">Method</a></li>
|
||
|
</ul>
|
||
|
<ul class="subNavList">
|
||
|
<li>Detail: </li>
|
||
|
<li>Field | </li>
|
||
|
<li>Constr | </li>
|
||
|
<li><a href="#method_detail">Method</a></li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<a name="skip-navbar_bottom">
|
||
|
<!-- -->
|
||
|
</a></div>
|
||
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
<p class="legalCopy"><small>Copyright © 1999–2022 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
|
||
|
</body>
|
||
|
</html>
|