blob: 50aa21aff25f52a1376ed0b7899477c55690a48a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CommonsHTTPClientProperties (Apache Axis)</title>
<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="CommonsHTTPClientProperties (Apache Axis)";
}
//-->
</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/CommonsHTTPClientProperties.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/axis/components/net/BooleanHolder.html" title="class in org.apache.axis.components.net"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis/components/net/CommonsHTTPClientPropertiesFactory.html" title="class in org.apache.axis.components.net"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis/components/net/CommonsHTTPClientProperties.html" target="_top">Frames</a></li>
<li><a href="CommonsHTTPClientProperties.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.axis.components.net</div>
<h2 title="Interface CommonsHTTPClientProperties" class="title">Interface CommonsHTTPClientProperties</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/axis/components/net/DefaultCommonsHTTPClientProperties.html" title="class in org.apache.axis.components.net">DefaultCommonsHTTPClientProperties</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">CommonsHTTPClientProperties</span></pre>
<div class="block">Interface implemented by classes seeking to configure the properties
of the multi threaded connection pool used in the CommonsHTTPSender
transport implementation.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Eric Friedman</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">&nbsp;</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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis/components/net/CommonsHTTPClientProperties.html#getConnectionPoolTimeout()">getConnectionPoolTimeout</a></strong>()</code>
<div class="block">Used to set the amount of time, in milliseconds, spent waiting
for an available connection from the pool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis/components/net/CommonsHTTPClientProperties.html#getDefaultConnectionTimeout()">getDefaultConnectionTimeout</a></strong>()</code>
<div class="block">Used to set the default amount of time, in milliseconds, spent waiting
for a connection.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis/components/net/CommonsHTTPClientProperties.html#getDefaultSoTimeout()">getDefaultSoTimeout</a></strong>()</code>
<div class="block">Used to set the default amount of time, in milliseconds, spent waiting
for a reponse.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis/components/net/CommonsHTTPClientProperties.html#getMaximumConnectionsPerHost()">getMaximumConnectionsPerHost</a></strong>()</code>
<div class="block">Used to set the maximum number of connections that will be pooled
for a given host.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis/components/net/CommonsHTTPClientProperties.html#getMaximumTotalConnections()">getMaximumTotalConnections</a></strong>()</code>
<div class="block">Used to set the maximum number of connections that the pool can open
for all hosts.</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="getMaximumTotalConnections()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumTotalConnections</h4>
<pre>int&nbsp;getMaximumTotalConnections()</pre>
<div class="block">Used to set the maximum number of connections that the pool can open
for all hosts. Since connections imply sockets and sockets imply
file descriptors, the setting you use must not exceed any limits
your system imposes on the number of open file descriptors a
single process may have.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer > 1</dd></dl>
</li>
</ul>
<a name="getMaximumConnectionsPerHost()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaximumConnectionsPerHost</h4>
<pre>int&nbsp;getMaximumConnectionsPerHost()</pre>
<div class="block">Used to set the maximum number of connections that will be pooled
for a given host. This setting is also constrained by
the one returned from getMaximumTotalConnections.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer > 1</dd></dl>
</li>
</ul>
<a name="getConnectionPoolTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionPoolTimeout</h4>
<pre>int&nbsp;getConnectionPoolTimeout()</pre>
<div class="block">Used to set the amount of time, in milliseconds, spent waiting
for an available connection from the pool. An exception is raised
if the timeout is triggered.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer > 1 OR 0 for infinite timeout</dd></dl>
</li>
</ul>
<a name="getDefaultConnectionTimeout()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDefaultConnectionTimeout</h4>
<pre>int&nbsp;getDefaultConnectionTimeout()</pre>
<div class="block">Used to set the default amount of time, in milliseconds, spent waiting
for a connection. This can be overridden by the MessageContext</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer >= 0</dd></dl>
</li>
</ul>
<a name="getDefaultSoTimeout()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDefaultSoTimeout</h4>
<pre>int&nbsp;getDefaultSoTimeout()</pre>
<div class="block">Used to set the default amount of time, in milliseconds, spent waiting
for a reponse. This can be overridden by the MessageContext</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an integer >= 0</dd></dl>
</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/CommonsHTTPClientProperties.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/axis/components/net/BooleanHolder.html" title="class in org.apache.axis.components.net"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis/components/net/CommonsHTTPClientPropertiesFactory.html" title="class in org.apache.axis.components.net"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis/components/net/CommonsHTTPClientProperties.html" target="_top">Frames</a></li>
<li><a href="CommonsHTTPClientProperties.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>