/lib/docs/org/apache/xmlrpc/util/ThreadPool.html
HTML | 383 lines | 318 code | 42 blank | 23 comment | 0 complexity | 33a067ae1e79b3274e91fa1b6a307b87 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_0) on Mon Apr 20 21:45:57 CEST 2009 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8ThreadPool (Apache XML-RPC 3.1.2 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2009-04-20"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="ThreadPool (Apache XML-RPC 3.1.2 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ThreadPool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../org/apache/xmlrpc/util/SAXParsers.html" title="class in org.apache.xmlrpc.util"><B>PREV CLASS</B></A> 60 <A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.InterruptableTask.html" title="interface in org.apache.xmlrpc.util"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?org/apache/xmlrpc/util/ThreadPool.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="ThreadPool.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92org.apache.xmlrpc.util</FONT> 93<BR> 94Class ThreadPool</H2> 95<PRE> 96java.lang.Object 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.util.ThreadPool</B> 98</PRE> 99<HR> 100<DL> 101<DT><PRE>public class <B>ThreadPool</B><DT>extends java.lang.Object</DL> 102</PRE> 103 104<P> 105Simple thread pool. A task is executed by obtaining a thread from 106 the pool 107<P> 108 109<P> 110<HR> 111 112<P> 113<!-- ======== NESTED CLASS SUMMARY ======== --> 114 115<A NAME="nested_class_summary"><!-- --></A> 116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 118<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 119<B>Nested Class Summary</B></FONT></TH> 120</TR> 121<TR BGCOLOR="white" CLASS="TableRowColor"> 122<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 123<CODE>static interface</CODE></FONT></TD> 124<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.InterruptableTask.html" title="interface in org.apache.xmlrpc.util">ThreadPool.InterruptableTask</A></B></CODE> 125 126<BR> 127 A task, which may be interrupted, if the pool is shutting down.</TD> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 131<CODE>static interface</CODE></FONT></TD> 132<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.Task.html" title="interface in org.apache.xmlrpc.util">ThreadPool.Task</A></B></CODE> 133 134<BR> 135 The thread pool contains instances of <A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.Task.html" title="interface in org.apache.xmlrpc.util"><CODE>ThreadPool.Task</CODE></A>.</TD> 136</TR> 137</TABLE> 138 139<!-- ======== CONSTRUCTOR SUMMARY ======== --> 140 141<A NAME="constructor_summary"><!-- --></A> 142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 144<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 145<B>Constructor Summary</B></FONT></TH> 146</TR> 147<TR BGCOLOR="white" CLASS="TableRowColor"> 148<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.html#ThreadPool(int, java.lang.String)">ThreadPool</A></B>(int pMaxSize, 149 java.lang.String pName)</CODE> 150 151<BR> 152 Creates a new instance.</TD> 153</TR> 154</TABLE> 155 156<!-- ========== METHOD SUMMARY =========== --> 157 158<A NAME="method_summary"><!-- --></A> 159<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 160<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 161<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 162<B>Method Summary</B></FONT></TH> 163</TR> 164<TR BGCOLOR="white" CLASS="TableRowColor"> 165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 166<CODE> boolean</CODE></FONT></TD> 167<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.html#addTask(org.apache.xmlrpc.util.ThreadPool.Task)">addTask</A></B>(<A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.Task.html" title="interface in org.apache.xmlrpc.util">ThreadPool.Task</A> pTask)</CODE> 168 169<BR> 170 Adds a task for immediate or deferred execution.</TD> 171</TR> 172<TR BGCOLOR="white" CLASS="TableRowColor"> 173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 174<CODE> int</CODE></FONT></TD> 175<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.html#getMaxThreads()">getMaxThreads</A></B>()</CODE> 176 177<BR> 178 Returns the maximum number of concurrent threads.</TD> 179</TR> 180<TR BGCOLOR="white" CLASS="TableRowColor"> 181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 182<CODE> int</CODE></FONT></TD> 183<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.html#getNumThreads()">getNumThreads</A></B>()</CODE> 184 185<BR> 186 Returns the number of threads, which have actually been created, 187 as opposed to the number of currently running threads.</TD> 188</TR> 189<TR BGCOLOR="white" CLASS="TableRowColor"> 190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 191<CODE> void</CODE></FONT></TD> 192<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.html#shutdown()">shutdown</A></B>()</CODE> 193 194<BR> 195 Closes the pool.</TD> 196</TR> 197<TR BGCOLOR="white" CLASS="TableRowColor"> 198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 199<CODE> boolean</CODE></FONT></TD> 200<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.html#startTask(org.apache.xmlrpc.util.ThreadPool.Task)">startTask</A></B>(<A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.Task.html" title="interface in org.apache.xmlrpc.util">ThreadPool.Task</A> pTask)</CODE> 201 202<BR> 203 Starts a task immediately.</TD> 204</TR> 205</TABLE> 206 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 207<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 208<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 209<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> 210</TR> 211<TR BGCOLOR="white" CLASS="TableRowColor"> 212<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> 213</TR> 214</TABLE> 215 216<P> 217 218<!-- ========= CONSTRUCTOR DETAIL ======== --> 219 220<A NAME="constructor_detail"><!-- --></A> 221<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 222<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 223<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 224<B>Constructor Detail</B></FONT></TH> 225</TR> 226</TABLE> 227 228<A NAME="ThreadPool(int, java.lang.String)"><!-- --></A><H3> 229ThreadPool</H3> 230<PRE> 231public <B>ThreadPool</B>(int pMaxSize, 232 java.lang.String pName)</PRE> 233<DL> 234<DD>Creates a new instance. 235<P> 236<DL> 237<DT><B>Parameters:</B><DD><CODE>pMaxSize</CODE> - Maximum number of concurrent threads.<DD><CODE>pName</CODE> - Thread group name.</DL> 238</DL> 239 240<!-- ============ METHOD DETAIL ========== --> 241 242<A NAME="method_detail"><!-- --></A> 243<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 244<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 245<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 246<B>Method Detail</B></FONT></TH> 247</TR> 248</TABLE> 249 250<A NAME="startTask(org.apache.xmlrpc.util.ThreadPool.Task)"><!-- --></A><H3> 251startTask</H3> 252<PRE> 253public boolean <B>startTask</B>(<A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.Task.html" title="interface in org.apache.xmlrpc.util">ThreadPool.Task</A> pTask)</PRE> 254<DL> 255<DD>Starts a task immediately. 256<P> 257<DD><DL> 258<DT><B>Parameters:</B><DD><CODE>pTask</CODE> - The task being started. 259<DT><B>Returns:</B><DD>True, if the task could be started immediately. False, if 260 the maxmimum number of concurrent tasks was exceeded. If so, you 261 might consider to use the <A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.html#addTask(org.apache.xmlrpc.util.ThreadPool.Task)"><CODE>addTask(ThreadPool.Task)</CODE></A> method instead.</DL> 262</DD> 263</DL> 264<HR> 265 266<A NAME="addTask(org.apache.xmlrpc.util.ThreadPool.Task)"><!-- --></A><H3> 267addTask</H3> 268<PRE> 269public boolean <B>addTask</B>(<A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.Task.html" title="interface in org.apache.xmlrpc.util">ThreadPool.Task</A> pTask)</PRE> 270<DL> 271<DD>Adds a task for immediate or deferred execution. 272<P> 273<DD><DL> 274<DT><B>Parameters:</B><DD><CODE>pTask</CODE> - The task being added. 275<DT><B>Returns:</B><DD>True, if the task was started immediately. False, if 276 the task will be executed later.</DL> 277</DD> 278</DL> 279<HR> 280 281<A NAME="shutdown()"><!-- --></A><H3> 282shutdown</H3> 283<PRE> 284public void <B>shutdown</B>()</PRE> 285<DL> 286<DD>Closes the pool. 287<P> 288<DD><DL> 289</DL> 290</DD> 291</DL> 292<HR> 293 294<A NAME="getMaxThreads()"><!-- --></A><H3> 295getMaxThreads</H3> 296<PRE> 297public int <B>getMaxThreads</B>()</PRE> 298<DL> 299<DD>Returns the maximum number of concurrent threads. 300<P> 301<DD><DL> 302 303<DT><B>Returns:</B><DD>Maximum number of threads.</DL> 304</DD> 305</DL> 306<HR> 307 308<A NAME="getNumThreads()"><!-- --></A><H3> 309getNumThreads</H3> 310<PRE> 311public int <B>getNumThreads</B>()</PRE> 312<DL> 313<DD>Returns the number of threads, which have actually been created, 314 as opposed to the number of currently running threads. 315<P> 316<DD><DL> 317</DL> 318</DD> 319</DL> 320<!-- ========= END OF CLASS DATA ========= --> 321<HR> 322 323 324<!-- ======= START OF BOTTOM NAVBAR ====== --> 325<A NAME="navbar_bottom"><!-- --></A> 326<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 327<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 328<TR> 329<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 330<A NAME="navbar_bottom_firstrow"><!-- --></A> 331<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 332 <TR ALIGN="center" VALIGN="top"> 333 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 334 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 335 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 336 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ThreadPool.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 337 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 338 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 339 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 340 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 341 </TR> 342</TABLE> 343</TD> 344<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 345</EM> 346</TD> 347</TR> 348 349<TR> 350<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 351 <A HREF="../../../../org/apache/xmlrpc/util/SAXParsers.html" title="class in org.apache.xmlrpc.util"><B>PREV CLASS</B></A> 352 <A HREF="../../../../org/apache/xmlrpc/util/ThreadPool.InterruptableTask.html" title="interface in org.apache.xmlrpc.util"><B>NEXT CLASS</B></A></FONT></TD> 353<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 354 <A HREF="../../../../index.html?org/apache/xmlrpc/util/ThreadPool.html" target="_top"><B>FRAMES</B></A> 355 <A HREF="ThreadPool.html" target="_top"><B>NO FRAMES</B></A> 356 <SCRIPT type="text/javascript"> 357 <!-- 358 if(window==top) { 359 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 360 } 361 //--> 362</SCRIPT> 363<NOSCRIPT> 364 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 365</NOSCRIPT> 366 367 368</FONT></TD> 369</TR> 370<TR> 371<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 372 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 373<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 374DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 375</TR> 376</TABLE> 377<A NAME="skip-navbar_bottom"></A> 378<!-- ======== END OF BOTTOM NAVBAR ======= --> 379 380<HR> 381Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. 382</BODY> 383</HTML>