PageRenderTime 29ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/docs/org/apache/xmlrpc/common/XmlRpcWorker.html

http://mp-rechnungs-und-kundenverwaltung.googlecode.com/
HTML | 249 lines | 200 code | 29 blank | 20 comment | 0 complexity | 28fecd6705b9603e90d050721cd0e6a5 MD5 | raw file
Possible License(s): LGPL-3.0, Apache-2.0, GPL-3.0, GPL-2.0, AGPL-3.0, JSON, BSD-3-Clause
  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>
  8. XmlRpcWorker (Apache XML-RPC 3.1.2 API)
  9. </TITLE>
  10. <META NAME="date" CONTENT="2009-04-20">
  11. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
  12. <SCRIPT type="text/javascript">
  13. function windowTitle()
  14. {
  15. if (location.href.indexOf('is-external=true') == -1) {
  16. parent.document.title="XmlRpcWorker (Apache XML-RPC 3.1.2 API)";
  17. }
  18. }
  19. </SCRIPT>
  20. <NOSCRIPT>
  21. </NOSCRIPT>
  22. </HEAD>
  23. <BODY BGCOLOR="white" onload="windowTitle();">
  24. <HR>
  25. <!-- ========= START OF TOP NAVBAR ======= -->
  26. <A NAME="navbar_top"><!-- --></A>
  27. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  28. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  29. <TR>
  30. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  31. <A NAME="navbar_top_firstrow"><!-- --></A>
  32. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  33. <TR ALIGN="center" VALIGN="top">
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcWorker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  40. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  41. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  42. </TR>
  43. </TABLE>
  44. </TD>
  45. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  46. </EM>
  47. </TD>
  48. </TR>
  49. <TR>
  50. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  51. &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestProcessor.html" title="interface in org.apache.xmlrpc.common"><B>PREV CLASS</B></A>&nbsp;
  52. &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorkerFactory.html" title="class in org.apache.xmlrpc.common"><B>NEXT CLASS</B></A></FONT></TD>
  53. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  54. <A HREF="../../../../index.html?org/apache/xmlrpc/common/XmlRpcWorker.html" target="_top"><B>FRAMES</B></A> &nbsp;
  55. &nbsp;<A HREF="XmlRpcWorker.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  56. &nbsp;<SCRIPT type="text/javascript">
  57. <!--
  58. if(window==top) {
  59. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  60. }
  61. //-->
  62. </SCRIPT>
  63. <NOSCRIPT>
  64. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  65. </NOSCRIPT>
  66. </FONT></TD>
  67. </TR>
  68. <TR>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  71. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  72. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  73. </TR>
  74. </TABLE>
  75. <A NAME="skip-navbar_top"></A>
  76. <!-- ========= END OF TOP NAVBAR ========= -->
  77. <HR>
  78. <!-- ======== START OF CLASS DATA ======== -->
  79. <H2>
  80. <FONT SIZE="-1">
  81. org.apache.xmlrpc.common</FONT>
  82. <BR>
  83. Interface XmlRpcWorker</H2>
  84. <DL>
  85. <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClientWorker.html" title="class in org.apache.xmlrpc.client">XmlRpcClientWorker</A>, <A HREF="../../../../org/apache/xmlrpc/server/XmlRpcServerWorker.html" title="class in org.apache.xmlrpc.server">XmlRpcServerWorker</A></DD>
  86. </DL>
  87. <HR>
  88. <DL>
  89. <DT><PRE>public interface <B>XmlRpcWorker</B></DL>
  90. </PRE>
  91. <P>
  92. An object, which executes requests on the controllers
  93. behalf. These objects are mainly used for controlling the
  94. clients or servers load, which is defined in terms of the
  95. number of currently active workers.
  96. <P>
  97. <P>
  98. <HR>
  99. <P>
  100. <!-- ========== METHOD SUMMARY =========== -->
  101. <A NAME="method_summary"><!-- --></A>
  102. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  103. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  104. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  105. <B>Method Summary</B></FONT></TH>
  106. </TR>
  107. <TR BGCOLOR="white" CLASS="TableRowColor">
  108. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  109. <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
  110. <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html#execute(org.apache.xmlrpc.XmlRpcRequest)">execute</A></B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A>&nbsp;pRequest)</CODE>
  111. <BR>
  112. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs a synchronous request.</TD>
  113. </TR>
  114. <TR BGCOLOR="white" CLASS="TableRowColor">
  115. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  116. <CODE>&nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcController.html" title="class in org.apache.xmlrpc.common">XmlRpcController</A></CODE></FONT></TD>
  117. <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html#getController()">getController</A></B>()</CODE>
  118. <BR>
  119. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the workers controller.</TD>
  120. </TR>
  121. </TABLE>
  122. &nbsp;
  123. <P>
  124. <!-- ============ METHOD DETAIL ========== -->
  125. <A NAME="method_detail"><!-- --></A>
  126. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  127. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  128. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  129. <B>Method Detail</B></FONT></TH>
  130. </TR>
  131. </TABLE>
  132. <A NAME="getController()"><!-- --></A><H3>
  133. getController</H3>
  134. <PRE>
  135. <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcController.html" title="class in org.apache.xmlrpc.common">XmlRpcController</A> <B>getController</B>()</PRE>
  136. <DL>
  137. <DD>Returns the workers controller.
  138. <P>
  139. <DD><DL>
  140. <DT><B>Returns:</B><DD>The controller, an instance of
  141. <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client"><CODE>XmlRpcClient</CODE></A>, or
  142. <A HREF="../../../../org/apache/xmlrpc/server/XmlRpcServer.html" title="class in org.apache.xmlrpc.server"><CODE>XmlRpcServer</CODE></A>.</DL>
  143. </DD>
  144. </DL>
  145. <HR>
  146. <A NAME="execute(org.apache.xmlrpc.XmlRpcRequest)"><!-- --></A><H3>
  147. execute</H3>
  148. <PRE>
  149. java.lang.Object <B>execute</B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A>&nbsp;pRequest)
  150. throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
  151. <DL>
  152. <DD>Performs a synchronous request. The client worker extends
  153. this interface with the ability to perform asynchronous
  154. requests.
  155. <P>
  156. <DD><DL>
  157. <DT><B>Parameters:</B><DD><CODE>pRequest</CODE> - The request being performed.
  158. <DT><B>Returns:</B><DD>The requests result.
  159. <DT><B>Throws:</B>
  160. <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE> - Performing the request failed.</DL>
  161. </DD>
  162. </DL>
  163. <!-- ========= END OF CLASS DATA ========= -->
  164. <HR>
  165. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  166. <A NAME="navbar_bottom"><!-- --></A>
  167. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  168. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  169. <TR>
  170. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  171. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  172. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  173. <TR ALIGN="center" VALIGN="top">
  174. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  175. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  176. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  177. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcWorker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  178. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  179. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  180. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  181. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  182. </TR>
  183. </TABLE>
  184. </TD>
  185. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  186. </EM>
  187. </TD>
  188. </TR>
  189. <TR>
  190. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  191. &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestProcessor.html" title="interface in org.apache.xmlrpc.common"><B>PREV CLASS</B></A>&nbsp;
  192. &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorkerFactory.html" title="class in org.apache.xmlrpc.common"><B>NEXT CLASS</B></A></FONT></TD>
  193. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  194. <A HREF="../../../../index.html?org/apache/xmlrpc/common/XmlRpcWorker.html" target="_top"><B>FRAMES</B></A> &nbsp;
  195. &nbsp;<A HREF="XmlRpcWorker.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  196. &nbsp;<SCRIPT type="text/javascript">
  197. <!--
  198. if(window==top) {
  199. document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  200. }
  201. //-->
  202. </SCRIPT>
  203. <NOSCRIPT>
  204. <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  205. </NOSCRIPT>
  206. </FONT></TD>
  207. </TR>
  208. <TR>
  209. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  210. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  211. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  212. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  213. </TR>
  214. </TABLE>
  215. <A NAME="skip-navbar_bottom"></A>
  216. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  217. <HR>
  218. Copyright &#169; 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
  219. </BODY>
  220. </HTML>