PageRenderTime 161ms CodeModel.GetById 60ms app.highlight 31ms RepoModel.GetById 30ms app.codeStats 0ms

/lib/docs/org/apache/xmlrpc/client/TimingOutCallback.html

http://mp-rechnungs-und-kundenverwaltung.googlecode.com/
HTML | 358 lines | 298 code | 37 blank | 23 comment | 0 complexity | 20350fe52f1b6e41c32455c0fca51109 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>
  8TimingOutCallback (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="TimingOutCallback (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>&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/TimingOutCallback.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/client/AsyncCallback.html" title="interface in org.apache.xmlrpc.client"><B>PREV CLASS</B></A>&nbsp;
 60&nbsp;<A HREF="../../../../org/apache/xmlrpc/client/TimingOutCallback.TimeoutException.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/TimingOutCallback.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 63&nbsp;<A HREF="TimingOutCallback.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 82DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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">
 92org.apache.xmlrpc.client</FONT>
 93<BR>
 94Class TimingOutCallback</H2>
 95<PRE>
 96java.lang.Object
 97  <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.client.TimingOutCallback</B>
 98</PRE>
 99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html" title="interface in org.apache.xmlrpc.client">AsyncCallback</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>TimingOutCallback</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html" title="interface in org.apache.xmlrpc.client">AsyncCallback</A></DL>
105</PRE>
106
107<P>
108<p>A callback object that can wait up to a specified amount
109 of time for the XML-RPC response. Suggested use is as follows:
110 </p>
111 <pre>
112   // Wait for 10 seconds.
113   TimingOutCallback callback = new TimingOutCallback(10 * 1000);
114   XmlRpcClient client = new XmlRpcClient(url);
115   client.executeAsync(methodName, aVector, callback);
116   try {
117       return callback.waitForResponse();
118   } catch (TimeoutException e) {
119       System.out.println("No response from server.");
120   } catch (Exception e) {
121       System.out.println("Server returned an error message.");
122   }
123 </pre>
124<P>
125
126<P>
127<HR>
128
129<P>
130<!-- ======== NESTED CLASS SUMMARY ======== -->
131
132<A NAME="nested_class_summary"><!-- --></A>
133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
136<B>Nested Class Summary</B></FONT></TH>
137</TR>
138<TR BGCOLOR="white" CLASS="TableRowColor">
139<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140<CODE>static&nbsp;class</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/TimingOutCallback.TimeoutException.html" title="class in org.apache.xmlrpc.client">TimingOutCallback.TimeoutException</A></B></CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This exception is thrown, if the request times out.</TD>
145</TR>
146</TABLE>
147&nbsp;
148<!-- ======== CONSTRUCTOR SUMMARY ======== -->
149
150<A NAME="constructor_summary"><!-- --></A>
151<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
153<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
154<B>Constructor Summary</B></FONT></TH>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/TimingOutCallback.html#TimingOutCallback(long)">TimingOutCallback</A></B>(long&nbsp;pTimeout)</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Waits the specified number of milliseconds for a response.</TD>
161</TR>
162</TABLE>
163&nbsp;
164<!-- ========== METHOD SUMMARY =========== -->
165
166<A NAME="method_summary"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
169<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
170<B>Method Summary</B></FONT></TH>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>&nbsp;void</CODE></FONT></TD>
175<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/TimingOutCallback.html#handleError(org.apache.xmlrpc.XmlRpcRequest, java.lang.Throwable)">handleError</A></B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A>&nbsp;pRequest,
176            java.lang.Throwable&nbsp;pError)</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Something went wrong, handle error.</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>&nbsp;void</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/TimingOutCallback.html#handleResult(org.apache.xmlrpc.XmlRpcRequest, java.lang.Object)">handleResult</A></B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A>&nbsp;pRequest,
185             java.lang.Object&nbsp;pResult)</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Call went ok, handle result.</TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/client/TimingOutCallback.html#waitForResponse()">waitForResponse</A></B>()</CODE>
194
195<BR>
196&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called to wait for the response.</TD>
197</TR>
198</TABLE>
199&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
202<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
206</TR>
207</TABLE>
208&nbsp;
209<P>
210
211<!-- ========= CONSTRUCTOR DETAIL ======== -->
212
213<A NAME="constructor_detail"><!-- --></A>
214<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
215<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
216<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
217<B>Constructor Detail</B></FONT></TH>
218</TR>
219</TABLE>
220
221<A NAME="TimingOutCallback(long)"><!-- --></A><H3>
222TimingOutCallback</H3>
223<PRE>
224public <B>TimingOutCallback</B>(long&nbsp;pTimeout)</PRE>
225<DL>
226<DD>Waits the specified number of milliseconds for a response.
227<P>
228</DL>
229
230<!-- ============ METHOD DETAIL ========== -->
231
232<A NAME="method_detail"><!-- --></A>
233<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
234<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
235<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
236<B>Method Detail</B></FONT></TH>
237</TR>
238</TABLE>
239
240<A NAME="waitForResponse()"><!-- --></A><H3>
241waitForResponse</H3>
242<PRE>
243public java.lang.Object <B>waitForResponse</B>()
244                                 throws java.lang.Throwable</PRE>
245<DL>
246<DD>Called to wait for the response.
247<P>
248<DD><DL>
249</DL>
250</DD>
251<DD><DL>
252
253<DT><B>Throws:</B>
254<DD><CODE>java.lang.InterruptedException</CODE> - The thread was interrupted.
255<DD><CODE><A HREF="../../../../org/apache/xmlrpc/client/TimingOutCallback.TimeoutException.html" title="class in org.apache.xmlrpc.client">TimingOutCallback.TimeoutException</A></CODE> - No response was received after waiting the specified time.
256<DD><CODE>java.lang.Throwable</CODE> - An error was returned by the server.</DL>
257</DD>
258</DL>
259<HR>
260
261<A NAME="handleError(org.apache.xmlrpc.XmlRpcRequest, java.lang.Throwable)"><!-- --></A><H3>
262handleError</H3>
263<PRE>
264public void <B>handleError</B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A>&nbsp;pRequest,
265                        java.lang.Throwable&nbsp;pError)</PRE>
266<DL>
267<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html#handleError(org.apache.xmlrpc.XmlRpcRequest, java.lang.Throwable)">AsyncCallback</A></CODE></B></DD>
268<DD>Something went wrong, handle error.
269<P>
270<DD><DL>
271<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html#handleError(org.apache.xmlrpc.XmlRpcRequest, java.lang.Throwable)">handleError</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html" title="interface in org.apache.xmlrpc.client">AsyncCallback</A></CODE></DL>
272</DD>
273<DD><DL>
274<DT><B>Parameters:</B><DD><CODE>pRequest</CODE> - The request being performed.<DD><CODE>pError</CODE> - The error being thrown.</DL>
275</DD>
276</DL>
277<HR>
278
279<A NAME="handleResult(org.apache.xmlrpc.XmlRpcRequest, java.lang.Object)"><!-- --></A><H3>
280handleResult</H3>
281<PRE>
282public void <B>handleResult</B>(<A HREF="../../../../org/apache/xmlrpc/XmlRpcRequest.html" title="interface in org.apache.xmlrpc">XmlRpcRequest</A>&nbsp;pRequest,
283                         java.lang.Object&nbsp;pResult)</PRE>
284<DL>
285<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html#handleResult(org.apache.xmlrpc.XmlRpcRequest, java.lang.Object)">AsyncCallback</A></CODE></B></DD>
286<DD>Call went ok, handle result.
287<P>
288<DD><DL>
289<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html#handleResult(org.apache.xmlrpc.XmlRpcRequest, java.lang.Object)">handleResult</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html" title="interface in org.apache.xmlrpc.client">AsyncCallback</A></CODE></DL>
290</DD>
291<DD><DL>
292<DT><B>Parameters:</B><DD><CODE>pRequest</CODE> - The request being performed.<DD><CODE>pResult</CODE> - The result object, which was returned by the server.</DL>
293</DD>
294</DL>
295<!-- ========= END OF CLASS DATA ========= -->
296<HR>
297
298
299<!-- ======= START OF BOTTOM NAVBAR ====== -->
300<A NAME="navbar_bottom"><!-- --></A>
301<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
302<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
303<TR>
304<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
305<A NAME="navbar_bottom_firstrow"><!-- --></A>
306<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
307  <TR ALIGN="center" VALIGN="top">
308  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
309  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
310  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
311  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/TimingOutCallback.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
312  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
313  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
314  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
315  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
316  </TR>
317</TABLE>
318</TD>
319<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
320</EM>
321</TD>
322</TR>
323
324<TR>
325<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
326&nbsp;<A HREF="../../../../org/apache/xmlrpc/client/AsyncCallback.html" title="interface in org.apache.xmlrpc.client"><B>PREV CLASS</B></A>&nbsp;
327&nbsp;<A HREF="../../../../org/apache/xmlrpc/client/TimingOutCallback.TimeoutException.html" title="class in org.apache.xmlrpc.client"><B>NEXT CLASS</B></A></FONT></TD>
328<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
329  <A HREF="../../../../index.html?org/apache/xmlrpc/client/TimingOutCallback.html" target="_top"><B>FRAMES</B></A>  &nbsp;
330&nbsp;<A HREF="TimingOutCallback.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
331&nbsp;<SCRIPT type="text/javascript">
332  <!--
333  if(window==top) {
334    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
335  }
336  //-->
337</SCRIPT>
338<NOSCRIPT>
339  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
340</NOSCRIPT>
341
342
343</FONT></TD>
344</TR>
345<TR>
346<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
347  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
348<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
349DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
350</TR>
351</TABLE>
352<A NAME="skip-navbar_bottom"></A>
353<!-- ======== END OF BOTTOM NAVBAR ======= -->
354
355<HR>
356Copyright &#169; 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
357</BODY>
358</HTML>