source: branches/objectmq_old/lib/rabbitmq-java-client-javadoc-3.0.1/com/rabbitmq/client/RpcServer.html

Last change on this file was 9, checked in by stoda, 12 years ago

First commit
File size: 23.6 KB
Line 
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_18) on Tue Dec 11 11:47:10 GMT 2012 -->
6<TITLE>
7RpcServer
8</TITLE>
9
10<META NAME="date" CONTENT="2012-12-11">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="RpcServer";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47  </TR>
48</TABLE>
49</TD>
50<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51</EM>
52</TD>
53</TR>
54
55<TR>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57&nbsp;<A HREF="../../../com/rabbitmq/client/RpcClient.html" title="class in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60  <A HREF="../../../index.html?com/rabbitmq/client/RpcServer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="RpcServer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62&nbsp;<SCRIPT type="text/javascript">
63  <!--
64  if(window==top) {
65    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
66  }
67  //-->
68</SCRIPT>
69<NOSCRIPT>
70  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
71</NOSCRIPT>
72
73
74</FONT></TD>
75</TR>
76<TR>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81</TR>
82</TABLE>
83<A NAME="skip-navbar_top"></A>
84<!-- ========= END OF TOP NAVBAR ========= -->
85
86<HR>
87<!-- ======== START OF CLASS DATA ======== -->
88<H2>
89<FONT SIZE="-1">
90com.rabbitmq.client</FONT>
91<BR>
92Class RpcServer</H2>
93<PRE>
94java.lang.Object
95  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.RpcServer</B>
96</PRE>
97<DL>
98<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/rabbitmq/client/MapRpcServer.html" title="class in com.rabbitmq.client">MapRpcServer</A>, <A HREF="../../../com/rabbitmq/client/StringRpcServer.html" title="class in com.rabbitmq.client">StringRpcServer</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public class <B>RpcServer</B><DT>extends java.lang.Object</DL>
103</PRE>
104
105<P>
106Class which manages a request queue for a simple RPC-style service.
107 The class is agnostic about the format of RPC arguments / return values.
108<P>
109
110<P>
111<HR>
112
113<P>
114
115<!-- ======== CONSTRUCTOR SUMMARY ======== -->
116
117<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#RpcServer(com.rabbitmq.client.Channel)">RpcServer</A></B>(<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A>&nbsp;channel)</CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates an RpcServer listening on a temporary exclusive
128 autodelete queue.</TD>
129</TR>
130<TR BGCOLOR="white" CLASS="TableRowColor">
131<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#RpcServer(com.rabbitmq.client.Channel, java.lang.String)">RpcServer</A></B>(<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A>&nbsp;channel,
132          java.lang.String&nbsp;queueName)</CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the passed-in queue name is null, creates a server-named
136 temporary exclusive autodelete queue to use; otherwise expects
137 the queue to have already been declared.</TD>
138</TR>
139</TABLE>
140&nbsp;
141<!-- ========== METHOD SUMMARY =========== -->
142
143<A NAME="method_summary"><!-- --></A>
144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
147<B>Method Summary</B></FONT></TH>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<CODE>&nbsp;void</CODE></FONT></TD>
152<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#close()">close</A></B>()</CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Public API - cancels the consumer, thus deleting the queue, if
156 it was a temporary queue, and marks the RpcServer as closed.</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>&nbsp;<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A></CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#getChannel()">getChannel</A></B>()</CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve the channel.</TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#getQueueName()">getQueueName</A></B>()</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve the queue name.</TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<CODE>&nbsp;byte[]</CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#handleCall(com.rabbitmq.client.AMQP.BasicProperties, byte[], com.rabbitmq.client.AMQP.BasicProperties)">handleCall</A></B>(<A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;requestProperties,
178           byte[]&nbsp;requestBody,
179           <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;replyProperties)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Mid-level response method.</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;byte[]</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#handleCall(byte[], com.rabbitmq.client.AMQP.BasicProperties)">handleCall</A></B>(byte[]&nbsp;requestBody,
188           <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;replyProperties)</CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;High-level response method.</TD>
192</TR>
193<TR BGCOLOR="white" CLASS="TableRowColor">
194<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
195<CODE>&nbsp;byte[]</CODE></FONT></TD>
196<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#handleCall(com.rabbitmq.client.QueueingConsumer.Delivery, com.rabbitmq.client.AMQP.BasicProperties)">handleCall</A></B>(<A HREF="../../../com/rabbitmq/client/QueueingConsumer.Delivery.html" title="class in com.rabbitmq.client">QueueingConsumer.Delivery</A>&nbsp;request,
197           <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;replyProperties)</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Lowest-level response method.</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;void</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#handleCast(com.rabbitmq.client.AMQP.BasicProperties, byte[])">handleCast</A></B>(<A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;requestProperties,
206           byte[]&nbsp;requestBody)</CODE>
207
208<BR>
209&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Mid-level handler method.</TD>
210</TR>
211<TR BGCOLOR="white" CLASS="TableRowColor">
212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
213<CODE>&nbsp;void</CODE></FONT></TD>
214<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#handleCast(byte[])">handleCast</A></B>(byte[]&nbsp;requestBody)</CODE>
215
216<BR>
217&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;High-level handler method.</TD>
218</TR>
219<TR BGCOLOR="white" CLASS="TableRowColor">
220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
221<CODE>&nbsp;void</CODE></FONT></TD>
222<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#handleCast(com.rabbitmq.client.QueueingConsumer.Delivery)">handleCast</A></B>(<A HREF="../../../com/rabbitmq/client/QueueingConsumer.Delivery.html" title="class in com.rabbitmq.client">QueueingConsumer.Delivery</A>&nbsp;request)</CODE>
223
224<BR>
225&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Lowest-level handler method.</TD>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229<CODE>&nbsp;<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A></CODE></FONT></TD>
230<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#mainloop()">mainloop</A></B>()</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Public API - main server loop.</TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<CODE>&nbsp;void</CODE></FONT></TD>
238<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#processRequest(com.rabbitmq.client.QueueingConsumer.Delivery)">processRequest</A></B>(<A HREF="../../../com/rabbitmq/client/QueueingConsumer.Delivery.html" title="class in com.rabbitmq.client">QueueingConsumer.Delivery</A>&nbsp;request)</CODE>
239
240<BR>
241&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Private API - Process a single request.</TD>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245<CODE>protected &nbsp;<A HREF="../../../com/rabbitmq/client/QueueingConsumer.html" title="class in com.rabbitmq.client">QueueingConsumer</A></CODE></FONT></TD>
246<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#setupConsumer()">setupConsumer</A></B>()</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Registers a consumer on the reply queue.</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>&nbsp;void</CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../com/rabbitmq/client/RpcServer.html#terminateMainloop()">terminateMainloop</A></B>()</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Call this method to terminate the mainloop.</TD>
258</TR>
259</TABLE>
260&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
261<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
262<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
263<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
267</TR>
268</TABLE>
269&nbsp;
270<P>
271
272<!-- ========= CONSTRUCTOR DETAIL ======== -->
273
274<A NAME="constructor_detail"><!-- --></A>
275<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
276<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
277<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
278<B>Constructor Detail</B></FONT></TH>
279</TR>
280</TABLE>
281
282<A NAME="RpcServer(com.rabbitmq.client.Channel)"><!-- --></A><H3>
283RpcServer</H3>
284<PRE>
285public <B>RpcServer</B>(<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A>&nbsp;channel)
286          throws java.io.IOException</PRE>
287<DL>
288<DD>Creates an RpcServer listening on a temporary exclusive
289 autodelete queue.
290<P>
291<DL>
292
293<DT><B>Throws:</B>
294<DD><CODE>java.io.IOException</CODE></DL>
295</DL>
296<HR>
297
298<A NAME="RpcServer(com.rabbitmq.client.Channel, java.lang.String)"><!-- --></A><H3>
299RpcServer</H3>
300<PRE>
301public <B>RpcServer</B>(<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A>&nbsp;channel,
302                 java.lang.String&nbsp;queueName)
303          throws java.io.IOException</PRE>
304<DL>
305<DD>If the passed-in queue name is null, creates a server-named
306 temporary exclusive autodelete queue to use; otherwise expects
307 the queue to have already been declared.
308<P>
309<DL>
310
311<DT><B>Throws:</B>
312<DD><CODE>java.io.IOException</CODE></DL>
313</DL>
314
315<!-- ============ METHOD DETAIL ========== -->
316
317<A NAME="method_detail"><!-- --></A>
318<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
319<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
320<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
321<B>Method Detail</B></FONT></TH>
322</TR>
323</TABLE>
324
325<A NAME="close()"><!-- --></A><H3>
326close</H3>
327<PRE>
328public void <B>close</B>()
329           throws java.io.IOException</PRE>
330<DL>
331<DD>Public API - cancels the consumer, thus deleting the queue, if
332 it was a temporary queue, and marks the RpcServer as closed.
333<P>
334<DD><DL>
335
336<DT><B>Throws:</B>
337<DD><CODE>java.io.IOException</CODE> - if an error is encountered</DL>
338</DD>
339</DL>
340<HR>
341
342<A NAME="setupConsumer()"><!-- --></A><H3>
343setupConsumer</H3>
344<PRE>
345protected <A HREF="../../../com/rabbitmq/client/QueueingConsumer.html" title="class in com.rabbitmq.client">QueueingConsumer</A> <B>setupConsumer</B>()
346                                  throws java.io.IOException</PRE>
347<DL>
348<DD>Registers a consumer on the reply queue.
349<P>
350<DD><DL>
351
352<DT><B>Returns:</B><DD>the newly created and registered consumer
353<DT><B>Throws:</B>
354<DD><CODE>java.io.IOException</CODE> - if an error is encountered</DL>
355</DD>
356</DL>
357<HR>
358
359<A NAME="mainloop()"><!-- --></A><H3>
360mainloop</H3>
361<PRE>
362public <A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A> <B>mainloop</B>()
363                                 throws java.io.IOException</PRE>
364<DL>
365<DD>Public API - main server loop. Call this to begin processing
366 requests. Request processing will continue until the Channel
367 (or its underlying Connection) is shut down, or until
368 terminateMainloop() is called.
369
370 Note that if the mainloop is blocked waiting for a request, the
371 termination flag is not checked until a request is received, so
372 a good time to call terminateMainloop() is during a request
373 handler.
374<P>
375<DD><DL>
376
377<DT><B>Returns:</B><DD>the exception that signalled the Channel shutdown, or null for orderly shutdown
378<DT><B>Throws:</B>
379<DD><CODE>java.io.IOException</CODE></DL>
380</DD>
381</DL>
382<HR>
383
384<A NAME="terminateMainloop()"><!-- --></A><H3>
385terminateMainloop</H3>
386<PRE>
387public void <B>terminateMainloop</B>()</PRE>
388<DL>
389<DD>Call this method to terminate the mainloop.
390
391 Note that if the mainloop is blocked waiting for a request, the
392 termination flag is not checked until a request is received, so
393 a good time to call terminateMainloop() is during a request
394 handler.
395<P>
396<DD><DL>
397</DL>
398</DD>
399</DL>
400<HR>
401
402<A NAME="processRequest(com.rabbitmq.client.QueueingConsumer.Delivery)"><!-- --></A><H3>
403processRequest</H3>
404<PRE>
405public void <B>processRequest</B>(<A HREF="../../../com/rabbitmq/client/QueueingConsumer.Delivery.html" title="class in com.rabbitmq.client">QueueingConsumer.Delivery</A>&nbsp;request)
406                    throws java.io.IOException</PRE>
407<DL>
408<DD>Private API - Process a single request. Called from mainloop().
409<P>
410<DD><DL>
411
412<DT><B>Throws:</B>
413<DD><CODE>java.io.IOException</CODE></DL>
414</DD>
415</DL>
416<HR>
417
418<A NAME="handleCall(com.rabbitmq.client.QueueingConsumer.Delivery, com.rabbitmq.client.AMQP.BasicProperties)"><!-- --></A><H3>
419handleCall</H3>
420<PRE>
421public byte[] <B>handleCall</B>(<A HREF="../../../com/rabbitmq/client/QueueingConsumer.Delivery.html" title="class in com.rabbitmq.client">QueueingConsumer.Delivery</A>&nbsp;request,
422                         <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;replyProperties)</PRE>
423<DL>
424<DD>Lowest-level response method. Calls
425 handleCall(AMQP.BasicProperties,byte[],AMQP.BasicProperties).
426<P>
427<DD><DL>
428</DL>
429</DD>
430</DL>
431<HR>
432
433<A NAME="handleCall(com.rabbitmq.client.AMQP.BasicProperties, byte[], com.rabbitmq.client.AMQP.BasicProperties)"><!-- --></A><H3>
434handleCall</H3>
435<PRE>
436public byte[] <B>handleCall</B>(<A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;requestProperties,
437                         byte[]&nbsp;requestBody,
438                         <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;replyProperties)</PRE>
439<DL>
440<DD>Mid-level response method. Calls
441 handleCall(byte[],AMQP.BasicProperties).
442<P>
443<DD><DL>
444</DL>
445</DD>
446</DL>
447<HR>
448
449<A NAME="handleCall(byte[], com.rabbitmq.client.AMQP.BasicProperties)"><!-- --></A><H3>
450handleCall</H3>
451<PRE>
452public byte[] <B>handleCall</B>(byte[]&nbsp;requestBody,
453                         <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;replyProperties)</PRE>
454<DL>
455<DD>High-level response method. Returns an empty response by
456 default - override this (or other handleCall and handleCast
457 methods) in subclasses.
458<P>
459<DD><DL>
460</DL>
461</DD>
462</DL>
463<HR>
464
465<A NAME="handleCast(com.rabbitmq.client.QueueingConsumer.Delivery)"><!-- --></A><H3>
466handleCast</H3>
467<PRE>
468public void <B>handleCast</B>(<A HREF="../../../com/rabbitmq/client/QueueingConsumer.Delivery.html" title="class in com.rabbitmq.client">QueueingConsumer.Delivery</A>&nbsp;request)</PRE>
469<DL>
470<DD>Lowest-level handler method. Calls
471 handleCast(AMQP.BasicProperties,byte[]).
472<P>
473<DD><DL>
474</DL>
475</DD>
476</DL>
477<HR>
478
479<A NAME="handleCast(com.rabbitmq.client.AMQP.BasicProperties, byte[])"><!-- --></A><H3>
480handleCast</H3>
481<PRE>
482public void <B>handleCast</B>(<A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;requestProperties,
483                       byte[]&nbsp;requestBody)</PRE>
484<DL>
485<DD>Mid-level handler method. Calls
486 handleCast(byte[]).
487<P>
488<DD><DL>
489</DL>
490</DD>
491</DL>
492<HR>
493
494<A NAME="handleCast(byte[])"><!-- --></A><H3>
495handleCast</H3>
496<PRE>
497public void <B>handleCast</B>(byte[]&nbsp;requestBody)</PRE>
498<DL>
499<DD>High-level handler method. Does nothing by default - override
500 this (or other handleCast and handleCast methods) in
501 subclasses.
502<P>
503<DD><DL>
504</DL>
505</DD>
506</DL>
507<HR>
508
509<A NAME="getChannel()"><!-- --></A><H3>
510getChannel</H3>
511<PRE>
512public <A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A> <B>getChannel</B>()</PRE>
513<DL>
514<DD>Retrieve the channel.
515<P>
516<DD><DL>
517
518<DT><B>Returns:</B><DD>the channel to which this server is connected</DL>
519</DD>
520</DL>
521<HR>
522
523<A NAME="getQueueName()"><!-- --></A><H3>
524getQueueName</H3>
525<PRE>
526public java.lang.String <B>getQueueName</B>()</PRE>
527<DL>
528<DD>Retrieve the queue name.
529<P>
530<DD><DL>
531
532<DT><B>Returns:</B><DD>the queue which this server is consuming from</DL>
533</DD>
534</DL>
535<!-- ========= END OF CLASS DATA ========= -->
536<HR>
537
538
539<!-- ======= START OF BOTTOM NAVBAR ====== -->
540<A NAME="navbar_bottom"><!-- --></A>
541<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
542<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
543<TR>
544<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
545<A NAME="navbar_bottom_firstrow"><!-- --></A>
546<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
547  <TR ALIGN="center" VALIGN="top">
548  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
549  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
550  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
551  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
552  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
553  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
554  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
555  </TR>
556</TABLE>
557</TD>
558<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
559</EM>
560</TD>
561</TR>
562
563<TR>
564<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
565&nbsp;<A HREF="../../../com/rabbitmq/client/RpcClient.html" title="class in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
566&nbsp;<A HREF="../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
567<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
568  <A HREF="../../../index.html?com/rabbitmq/client/RpcServer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
569&nbsp;<A HREF="RpcServer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
570&nbsp;<SCRIPT type="text/javascript">
571  <!--
572  if(window==top) {
573    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
574  }
575  //-->
576</SCRIPT>
577<NOSCRIPT>
578  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
579</NOSCRIPT>
580
581
582</FONT></TD>
583</TR>
584<TR>
585<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
586  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
587<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
588DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
589</TR>
590</TABLE>
591<A NAME="skip-navbar_bottom"></A>
592<!-- ======== END OF BOTTOM NAVBAR ======= -->
593
594<HR>
595
596</BODY>
597</HTML>
Note: See TracBrowser for help on using the repository browser.