/lib/docs/org/apache/xmlrpc/client/XmlRpcClientWorker.html
HTML | 356 lines | 296 code | 38 blank | 22 comment | 0 complexity | 8dcc2d410dc25133d52d48cf933947d6 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:58 CEST 2009 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8XmlRpcClientWorker (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="XmlRpcClientWorker (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/XmlRpcClientWorker.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/client/XmlRpcClientRequestImpl.html" title="class in org.apache.xmlrpc.client"><B>PREV CLASS</B></A> 60 <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorkerFactory.html" title="class in org.apache.xmlrpc.client"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?org/apache/xmlrpc/client/XmlRpcClientWorker.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="XmlRpcClientWorker.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: NESTED | 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.client</FONT> 93<BR> 94Class XmlRpcClientWorker</H2> 95<PRE> 96java.lang.Object 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.client.XmlRpcClientWorker</B> 98</PRE> 99<DL> 100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html" title="interface in org.apache.xmlrpc.common">XmlRpcWorker</A></DD> 101</DL> 102<HR> 103<DL> 104<DT><PRE>public class <B>XmlRpcClientWorker</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html" title="interface in org.apache.xmlrpc.common">XmlRpcWorker</A></DL> 105</PRE> 106 107<P> 108Object, which performs a request on the clients behalf. 109 The client maintains a pool of workers. The main purpose of the 110 pool is limitation of the maximum number of concurrent requests. 111<P> 112 113<P> 114<DL> 115<DT><B>Since:</B></DT> 116 <DD>3.0</DD> 117</DL> 118<HR> 119 120<P> 121 122<!-- ======== CONSTRUCTOR SUMMARY ======== --> 123 124<A NAME="constructor_summary"><!-- --></A> 125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 126<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 127<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 128<B>Constructor Summary</B></FONT></TH> 129</TR> 130<TR BGCOLOR="white" CLASS="TableRowColor"> 131<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorker.html#XmlRpcClientWorker(org.apache.xmlrpc.client.XmlRpcClientWorkerFactory)">XmlRpcClientWorker</A></B>(<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorkerFactory.html" title="class in org.apache.xmlrpc.client">XmlRpcClientWorkerFactory</A> pFactory)</CODE> 132 133<BR> 134 Creates a new instance.</TD> 135</TR> 136</TABLE> 137 138<!-- ========== METHOD SUMMARY =========== --> 139 140<A NAME="method_summary"><!-- --></A> 141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 142<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 143<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 144<B>Method Summary</B></FONT></TH> 145</TR> 146<TR BGCOLOR="white" CLASS="TableRowColor"> 147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 148<CODE> java.lang.Object</CODE></FONT></TD> 149<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorker.html#execute(org.apache.xmlrpc.XmlRpcRequest)">execute</A></B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A> pRequest)</CODE> 150 151<BR> 152 Performs a synchronous request.</TD> 153</TR> 154<TR BGCOLOR="white" CLASS="TableRowColor"> 155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 156<CODE> void</CODE></FONT></TD> 157<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorker.html#execute(org.apache.xmlrpc.XmlRpcRequest, org.apache.xmlrpc.client.AsyncCallback)">execute</A></B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A> pRequest, 158 <A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html" title="interface in org.apache.xmlrpc.client">AsyncCallback</A> pCallback)</CODE> 159 160<BR> 161 Performs an synchronous request.</TD> 162</TR> 163<TR BGCOLOR="white" CLASS="TableRowColor"> 164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 165<CODE> <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcController.html" title="class in org.apache.xmlrpc.common">XmlRpcController</A></CODE></FONT></TD> 166<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorker.html#getController()">getController</A></B>()</CODE> 167 168<BR> 169 Returns the workers controller.</TD> 170</TR> 171<TR BGCOLOR="white" CLASS="TableRowColor"> 172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 173<CODE>protected java.lang.Thread</CODE></FONT></TD> 174<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorker.html#newThread(java.lang.Runnable)">newThread</A></B>(java.lang.Runnable pRunnable)</CODE> 175 176<BR> 177 </TD> 178</TR> 179</TABLE> 180 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 182<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 183<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> 184</TR> 185<TR BGCOLOR="white" CLASS="TableRowColor"> 186<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> 187</TR> 188</TABLE> 189 190<P> 191 192<!-- ========= CONSTRUCTOR DETAIL ======== --> 193 194<A NAME="constructor_detail"><!-- --></A> 195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 196<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 197<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 198<B>Constructor Detail</B></FONT></TH> 199</TR> 200</TABLE> 201 202<A NAME="XmlRpcClientWorker(org.apache.xmlrpc.client.XmlRpcClientWorkerFactory)"><!-- --></A><H3> 203XmlRpcClientWorker</H3> 204<PRE> 205public <B>XmlRpcClientWorker</B>(<A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorkerFactory.html" title="class in org.apache.xmlrpc.client">XmlRpcClientWorkerFactory</A> pFactory)</PRE> 206<DL> 207<DD>Creates a new instance. 208<P> 209<DL> 210<DT><B>Parameters:</B><DD><CODE>pFactory</CODE> - The factory, which is being notified, if 211 the worker's ready.</DL> 212</DL> 213 214<!-- ============ METHOD DETAIL ========== --> 215 216<A NAME="method_detail"><!-- --></A> 217<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 218<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 219<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 220<B>Method Detail</B></FONT></TH> 221</TR> 222</TABLE> 223 224<A NAME="getController()"><!-- --></A><H3> 225getController</H3> 226<PRE> 227public <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcController.html" title="class in org.apache.xmlrpc.common">XmlRpcController</A> <B>getController</B>()</PRE> 228<DL> 229<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html#getController()">XmlRpcWorker</A></CODE></B></DD> 230<DD>Returns the workers controller. 231<P> 232<DD><DL> 233<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html#getController()">getController</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html" title="interface in org.apache.xmlrpc.common">XmlRpcWorker</A></CODE></DL> 234</DD> 235<DD><DL> 236 237<DT><B>Returns:</B><DD>The controller, an instance of 238 <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client"><CODE>XmlRpcClient</CODE></A>, or 239 <A HREF="../../../../org/apache/xmlrpc/server/XmlRpcServer.html" title="class in org.apache.xmlrpc.server"><CODE>XmlRpcServer</CODE></A>.</DL> 240</DD> 241</DL> 242<HR> 243 244<A NAME="execute(org.apache.xmlrpc.XmlRpcRequest)"><!-- --></A><H3> 245execute</H3> 246<PRE> 247public java.lang.Object <B>execute</B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A> pRequest) 248 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE> 249<DL> 250<DD>Performs a synchronous request. 251<P> 252<DD><DL> 253<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html#execute(org.apache.xmlrpc.XmlRpcRequest)">execute</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html" title="interface in org.apache.xmlrpc.common">XmlRpcWorker</A></CODE></DL> 254</DD> 255<DD><DL> 256<DT><B>Parameters:</B><DD><CODE>pRequest</CODE> - The request being performed. 257<DT><B>Returns:</B><DD>The requests result. 258<DT><B>Throws:</B> 259<DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE> - Performing the request failed.</DL> 260</DD> 261</DL> 262<HR> 263 264<A NAME="newThread(java.lang.Runnable)"><!-- --></A><H3> 265newThread</H3> 266<PRE> 267protected java.lang.Thread <B>newThread</B>(java.lang.Runnable pRunnable)</PRE> 268<DL> 269<DD><DL> 270</DL> 271</DD> 272<DD><DL> 273</DL> 274</DD> 275</DL> 276<HR> 277 278<A NAME="execute(org.apache.xmlrpc.XmlRpcRequest, org.apache.xmlrpc.client.AsyncCallback)"><!-- --></A><H3> 279execute</H3> 280<PRE> 281public void <B>execute</B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A> pRequest, 282 <A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html" title="interface in org.apache.xmlrpc.client">AsyncCallback</A> pCallback)</PRE> 283<DL> 284<DD>Performs an synchronous request. 285<P> 286<DD><DL> 287</DL> 288</DD> 289<DD><DL> 290<DT><B>Parameters:</B><DD><CODE>pRequest</CODE> - The request being performed.<DD><CODE>pCallback</CODE> - The callback being invoked, when the request is finished.</DL> 291</DD> 292</DL> 293<!-- ========= END OF CLASS DATA ========= --> 294<HR> 295 296 297<!-- ======= START OF BOTTOM NAVBAR ====== --> 298<A NAME="navbar_bottom"><!-- --></A> 299<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 300<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 301<TR> 302<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 303<A NAME="navbar_bottom_firstrow"><!-- --></A> 304<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 305 <TR ALIGN="center" VALIGN="top"> 306 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 307 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 308 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 309 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcClientWorker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 310 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 311 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 312 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 314 </TR> 315</TABLE> 316</TD> 317<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 318</EM> 319</TD> 320</TR> 321 322<TR> 323<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 324 <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientRequestImpl.html" title="class in org.apache.xmlrpc.client"><B>PREV CLASS</B></A> 325 <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorkerFactory.html" title="class in org.apache.xmlrpc.client"><B>NEXT CLASS</B></A></FONT></TD> 326<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 327 <A HREF="../../../../index.html?org/apache/xmlrpc/client/XmlRpcClientWorker.html" target="_top"><B>FRAMES</B></A> 328 <A HREF="XmlRpcClientWorker.html" target="_top"><B>NO FRAMES</B></A> 329 <SCRIPT type="text/javascript"> 330 <!-- 331 if(window==top) { 332 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 333 } 334 //--> 335</SCRIPT> 336<NOSCRIPT> 337 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 338</NOSCRIPT> 339 340 341</FONT></TD> 342</TR> 343<TR> 344<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 345 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 346<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 347DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 348</TR> 349</TABLE> 350<A NAME="skip-navbar_bottom"></A> 351<!-- ======== END OF BOTTOM NAVBAR ======= --> 352 353<HR> 354Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. 355</BODY> 356</HTML>