/usr/share/doc/libasync-http-client-java/api/com/ning/http/client/extra/ThrottleRequestFilter.html is in libasync-http-client-java-doc 1.6.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Sat Dec 03 01:24:04 UTC 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
ThrottleRequestFilter (Asynchronous Http Client 1.6.5 API)
</TITLE>
<META NAME="date" CONTENT="2011-12-03">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ThrottleRequestFilter (Asynchronous Http Client 1.6.5 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ThrottleRequestFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/ning/http/client/extra/ResumableRandomAccessFileListener.html" title="class in com.ning.http.client.extra"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/ning/http/client/extra/ThrottleRequestFilter.html" target="_top"><B>FRAMES</B></A>
<A HREF="ThrottleRequestFilter.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.ning.http.client.extra</FONT>
<BR>
Class ThrottleRequestFilter</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.ning.http.client.extra.ThrottleRequestFilter</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/ning/http/client/filter/RequestFilter.html" title="interface in com.ning.http.client.filter">RequestFilter</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>ThrottleRequestFilter</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../com/ning/http/client/filter/RequestFilter.html" title="interface in com.ning.http.client.filter">RequestFilter</A></DL>
</PRE>
<P>
A <A HREF="../../../../../com/ning/http/client/filter/RequestFilter.html" title="interface in com.ning.http.client.filter"><CODE>RequestFilter</CODE></A> throttles requests and block when the number of permits is reached, waiting for
the response to arrives before executing the next request.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/ning/http/client/extra/ThrottleRequestFilter.html#ThrottleRequestFilter(int)">ThrottleRequestFilter</A></B>(int maxConnections)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../com/ning/http/client/extra/ThrottleRequestFilter.html#ThrottleRequestFilter(int, int)">ThrottleRequestFilter</A></B>(int maxConnections,
int maxWait)</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../com/ning/http/client/filter/FilterContext.html" title="class in com.ning.http.client.filter">FilterContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../com/ning/http/client/extra/ThrottleRequestFilter.html#filter(com.ning.http.client.filter.FilterContext)">filter</A></B>(<A HREF="../../../../../com/ning/http/client/filter/FilterContext.html" title="class in com.ning.http.client.filter">FilterContext</A> ctx)</CODE>
<BR>
An <A HREF="../../../../../com/ning/http/client/AsyncHttpProvider.html" title="interface in com.ning.http.client"><CODE>AsyncHttpProvider</CODE></A> will invoke <A HREF="../../../../../com/ning/http/client/filter/RequestFilter.html#filter(com.ning.http.client.filter.FilterContext)"><CODE>RequestFilter.filter(com.ning.http.client.filter.FilterContext)</CODE></A> and will use the
returned <A HREF="../../../../../com/ning/http/client/filter/FilterContext.html#getRequest()"><CODE>FilterContext.getRequest()</CODE></A> and <A HREF="../../../../../com/ning/http/client/filter/FilterContext.html#getAsyncHandler()"><CODE>FilterContext.getAsyncHandler()</CODE></A> to continue the request
processing.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ThrottleRequestFilter(int)"><!-- --></A><H3>
ThrottleRequestFilter</H3>
<PRE>
public <B>ThrottleRequestFilter</B>(int maxConnections)</PRE>
<DL>
</DL>
<HR>
<A NAME="ThrottleRequestFilter(int, int)"><!-- --></A><H3>
ThrottleRequestFilter</H3>
<PRE>
public <B>ThrottleRequestFilter</B>(int maxConnections,
int maxWait)</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="filter(com.ning.http.client.filter.FilterContext)"><!-- --></A><H3>
filter</H3>
<PRE>
public <A HREF="../../../../../com/ning/http/client/filter/FilterContext.html" title="class in com.ning.http.client.filter">FilterContext</A> <B>filter</B>(<A HREF="../../../../../com/ning/http/client/filter/FilterContext.html" title="class in com.ning.http.client.filter">FilterContext</A> ctx)
throws <A HREF="../../../../../com/ning/http/client/filter/FilterException.html" title="class in com.ning.http.client.filter">FilterException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/ning/http/client/filter/RequestFilter.html#filter(com.ning.http.client.filter.FilterContext)">RequestFilter</A></CODE></B></DD>
<DD>An <A HREF="../../../../../com/ning/http/client/AsyncHttpProvider.html" title="interface in com.ning.http.client"><CODE>AsyncHttpProvider</CODE></A> will invoke <A HREF="../../../../../com/ning/http/client/filter/RequestFilter.html#filter(com.ning.http.client.filter.FilterContext)"><CODE>RequestFilter.filter(com.ning.http.client.filter.FilterContext)</CODE></A> and will use the
returned <A HREF="../../../../../com/ning/http/client/filter/FilterContext.html#getRequest()"><CODE>FilterContext.getRequest()</CODE></A> and <A HREF="../../../../../com/ning/http/client/filter/FilterContext.html#getAsyncHandler()"><CODE>FilterContext.getAsyncHandler()</CODE></A> to continue the request
processing.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/ning/http/client/filter/RequestFilter.html#filter(com.ning.http.client.filter.FilterContext)">filter</A></CODE> in interface <CODE><A HREF="../../../../../com/ning/http/client/filter/RequestFilter.html" title="interface in com.ning.http.client.filter">RequestFilter</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ctx</CODE> - a <A HREF="../../../../../com/ning/http/client/filter/FilterContext.html" title="class in com.ning.http.client.filter"><CODE>FilterContext</CODE></A>
<DT><B>Returns:</B><DD><A HREF="../../../../../com/ning/http/client/filter/FilterContext.html" title="class in com.ning.http.client.filter"><CODE>FilterContext</CODE></A>. The <A HREF="../../../../../com/ning/http/client/filter/FilterContext.html" title="class in com.ning.http.client.filter"><CODE>FilterContext</CODE></A> instance may not the same as the original one.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ning/http/client/filter/FilterException.html" title="class in com.ning.http.client.filter">FilterException</A></CODE> - to interrupt the filter processing.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ThrottleRequestFilter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../com/ning/http/client/extra/ResumableRandomAccessFileListener.html" title="class in com.ning.http.client.extra"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?com/ning/http/client/extra/ThrottleRequestFilter.html" target="_top"><B>FRAMES</B></A>
<A HREF="ThrottleRequestFilter.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2011. All Rights Reserved.
</BODY>
</HTML>
|