comparison apache-xmlrpc-3.1.3/docs/apidocs/org/apache/xmlrpc/common/XmlRpcWorker.html @ 151:db5f735fd2b4

add xml-rpc.jar
author e085711
date Sat, 10 Sep 2011 04:13:50 +0900
parents
children
comparison
equal deleted inserted replaced
147:a2b5149bbbe6 151:db5f735fd2b4
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_17) on Sat Feb 06 17:11:25 CET 2010 -->
6 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 <TITLE>
8 XmlRpcWorker (Apache XML-RPC 3.1.3 API)
9 </TITLE>
10
11 <META NAME="date" CONTENT="2010-02-06">
12
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
14
15 <SCRIPT type="text/javascript">
16 function windowTitle()
17 {
18 if (location.href.indexOf('is-external=true') == -1) {
19 parent.document.title="XmlRpcWorker (Apache XML-RPC 3.1.3 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>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcWorker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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 &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestProcessor.html" title="interface in org.apache.xmlrpc.common"><B>PREV CLASS</B></A>&nbsp;
60 &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorkerFactory.html" title="class in org.apache.xmlrpc.common"><B>NEXT CLASS</B></A></FONT></TD>
61 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62 <A HREF="../../../../index.html?org/apache/xmlrpc/common/XmlRpcWorker.html" target="_top"><B>FRAMES</B></A> &nbsp;
63 &nbsp;<A HREF="XmlRpcWorker.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
64 &nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
81 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
82 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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">
92 org.apache.xmlrpc.common</FONT>
93 <BR>
94 Interface XmlRpcWorker</H2>
95 <DL>
96 <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>
97 </DL>
98 <HR>
99 <DL>
100 <DT><PRE>public interface <B>XmlRpcWorker</B></DL>
101 </PRE>
102
103 <P>
104 An object, which executes requests on the controllers
105 behalf. These objects are mainly used for controlling the
106 clients or servers load, which is defined in terms of the
107 number of currently active workers.
108 <P>
109
110 <P>
111 <HR>
112
113 <P>
114
115 <!-- ========== METHOD SUMMARY =========== -->
116
117 <A NAME="method_summary"><!-- --></A>
118 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121 <B>Method Summary</B></FONT></TH>
122 </TR>
123 <TR BGCOLOR="white" CLASS="TableRowColor">
124 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125 <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
126 <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>
127
128 <BR>
129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs a synchronous request.</TD>
130 </TR>
131 <TR BGCOLOR="white" CLASS="TableRowColor">
132 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133 <CODE>&nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcController.html" title="class in org.apache.xmlrpc.common">XmlRpcController</A></CODE></FONT></TD>
134 <TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorker.html#getController()">getController</A></B>()</CODE>
135
136 <BR>
137 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the workers controller.</TD>
138 </TR>
139 </TABLE>
140 &nbsp;
141 <P>
142
143 <!-- ============ METHOD DETAIL ========== -->
144
145 <A NAME="method_detail"><!-- --></A>
146 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
148 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
149 <B>Method Detail</B></FONT></TH>
150 </TR>
151 </TABLE>
152
153 <A NAME="getController()"><!-- --></A><H3>
154 getController</H3>
155 <PRE>
156 <A HREF="../../../../org/apache/xmlrpc/common/XmlRpcController.html" title="class in org.apache.xmlrpc.common">XmlRpcController</A> <B>getController</B>()</PRE>
157 <DL>
158 <DD>Returns the workers controller.
159 <P>
160 <DD><DL>
161
162 <DT><B>Returns:</B><DD>The controller, an instance of
163 <A HREF="../../../../org/apache/xmlrpc/client/XmlRpcClient.html" title="class in org.apache.xmlrpc.client"><CODE>XmlRpcClient</CODE></A>, or
164 <A HREF="../../../../org/apache/xmlrpc/server/XmlRpcServer.html" title="class in org.apache.xmlrpc.server"><CODE>XmlRpcServer</CODE></A>.</DL>
165 </DD>
166 </DL>
167 <HR>
168
169 <A NAME="execute(org.apache.xmlrpc.XmlRpcRequest)"><!-- --></A><H3>
170 execute</H3>
171 <PRE>
172 java.lang.Object <B>execute</B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A>&nbsp;pRequest)
173 throws <A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></PRE>
174 <DL>
175 <DD>Performs a synchronous request. The client worker extends
176 this interface with the ability to perform asynchronous
177 requests.
178 <P>
179 <DD><DL>
180 <DT><B>Parameters:</B><DD><CODE>pRequest</CODE> - The request being performed.
181 <DT><B>Returns:</B><DD>The requests result.
182 <DT><B>Throws:</B>
183 <DD><CODE><A HREF="../../../../org/apache/xmlrpc/XmlRpcException.html" title="class in org.apache.xmlrpc">XmlRpcException</A></CODE> - Performing the request failed.</DL>
184 </DD>
185 </DL>
186 <!-- ========= END OF CLASS DATA ========= -->
187 <HR>
188
189
190 <!-- ======= START OF BOTTOM NAVBAR ====== -->
191 <A NAME="navbar_bottom"><!-- --></A>
192 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
193 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
194 <TR>
195 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
196 <A NAME="navbar_bottom_firstrow"><!-- --></A>
197 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
198 <TR ALIGN="center" VALIGN="top">
199 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
200 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
201 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
202 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XmlRpcWorker.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
203 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
204 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
205 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
206 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
207 </TR>
208 </TABLE>
209 </TD>
210 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
211 </EM>
212 </TD>
213 </TR>
214
215 <TR>
216 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
217 &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcStreamRequestProcessor.html" title="interface in org.apache.xmlrpc.common"><B>PREV CLASS</B></A>&nbsp;
218 &nbsp;<A HREF="../../../../org/apache/xmlrpc/common/XmlRpcWorkerFactory.html" title="class in org.apache.xmlrpc.common"><B>NEXT CLASS</B></A></FONT></TD>
219 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
220 <A HREF="../../../../index.html?org/apache/xmlrpc/common/XmlRpcWorker.html" target="_top"><B>FRAMES</B></A> &nbsp;
221 &nbsp;<A HREF="XmlRpcWorker.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
222 &nbsp;<SCRIPT type="text/javascript">
223 <!--
224 if(window==top) {
225 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
226 }
227 //-->
228 </SCRIPT>
229 <NOSCRIPT>
230 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
231 </NOSCRIPT>
232
233
234 </FONT></TD>
235 </TR>
236 <TR>
237 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
238 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
239 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
240 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
241 </TR>
242 </TABLE>
243 <A NAME="skip-navbar_bottom"></A>
244 <!-- ======== END OF BOTTOM NAVBAR ======= -->
245
246 <HR>
247 Copyright &#169; 2001-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
248 </BODY>
249 </HTML>