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

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

First commit
File size: 14.3 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:09 GMT 2012 -->
6<TITLE>
7GetResponse
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="GetResponse";
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/FlowListener.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../com/rabbitmq/client/JDKSaslConfig.html" title="class 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/GetResponse.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="GetResponse.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 GetResponse</H2>
93<PRE>
94java.lang.Object
95  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.GetResponse</B>
96</PRE>
97<HR>
98<DL>
99<DT><PRE>public class <B>GetResponse</B><DT>extends java.lang.Object</DL>
100</PRE>
101
102<P>
103Encapsulates the response from a <A HREF="../../../com/rabbitmq/client/Channel.html#basicGet(java.lang.String, boolean)"><CODE>Channel.basicGet(java.lang.String, boolean)</CODE></A> message-retrieval method call
104 - essentially a static bean "holder" with message response data.
105<P>
106
107<P>
108<HR>
109
110<P>
111
112<!-- ======== CONSTRUCTOR SUMMARY ======== -->
113
114<A NAME="constructor_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
118<B>Constructor Summary</B></FONT></TH>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD><CODE><B><A HREF="../../../com/rabbitmq/client/GetResponse.html#GetResponse(com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[], int)">GetResponse</A></B>(<A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client">Envelope</A>&nbsp;envelope,
122            <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;props,
123            byte[]&nbsp;body,
124            int&nbsp;messageCount)</CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a <A HREF="../../../com/rabbitmq/client/GetResponse.html" title="class in com.rabbitmq.client"><CODE>GetResponse</CODE></A> with the specified construction parameters</TD>
128</TR>
129</TABLE>
130&nbsp;
131<!-- ========== METHOD SUMMARY =========== -->
132
133<A NAME="method_summary"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
137<B>Method Summary</B></FONT></TH>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>&nbsp;byte[]</CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../com/rabbitmq/client/GetResponse.html#getBody()">getBody</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the message body included in this response</TD>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
149<CODE>&nbsp;<A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client">Envelope</A></CODE></FONT></TD>
150<TD><CODE><B><A HREF="../../../com/rabbitmq/client/GetResponse.html#getEnvelope()">getEnvelope</A></B>()</CODE>
151
152<BR>
153&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the <A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client"><CODE>Envelope</CODE></A> included in this response</TD>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
157<CODE>&nbsp;int</CODE></FONT></TD>
158<TD><CODE><B><A HREF="../../../com/rabbitmq/client/GetResponse.html#getMessageCount()">getMessageCount</A></B>()</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the server's most recent estimate of the number of messages
162 remaining on the queue.</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>&nbsp;<A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A></CODE></FONT></TD>
167<TD><CODE><B><A HREF="../../../com/rabbitmq/client/GetResponse.html#getProps()">getProps</A></B>()</CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the <A HREF="../../../com/rabbitmq/client/BasicProperties.html" title="interface in com.rabbitmq.client"><CODE>BasicProperties</CODE></A> included in this response</TD>
171</TR>
172</TABLE>
173&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
175<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
176<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
180</TR>
181</TABLE>
182&nbsp;
183<P>
184
185<!-- ========= CONSTRUCTOR DETAIL ======== -->
186
187<A NAME="constructor_detail"><!-- --></A>
188<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
189<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
190<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
191<B>Constructor Detail</B></FONT></TH>
192</TR>
193</TABLE>
194
195<A NAME="GetResponse(com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[], int)"><!-- --></A><H3>
196GetResponse</H3>
197<PRE>
198public <B>GetResponse</B>(<A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client">Envelope</A>&nbsp;envelope,
199                   <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A>&nbsp;props,
200                   byte[]&nbsp;body,
201                   int&nbsp;messageCount)</PRE>
202<DL>
203<DD>Construct a <A HREF="../../../com/rabbitmq/client/GetResponse.html" title="class in com.rabbitmq.client"><CODE>GetResponse</CODE></A> with the specified construction parameters
204<P>
205<DL>
206<DT><B>Parameters:</B><DD><CODE>envelope</CODE> - the <A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client"><CODE>Envelope</CODE></A><DD><CODE>props</CODE> - message properties<DD><CODE>body</CODE> - the message body<DD><CODE>messageCount</CODE> - the server's most recent estimate of the number of messages remaining on the queue</DL>
207</DL>
208
209<!-- ============ METHOD DETAIL ========== -->
210
211<A NAME="method_detail"><!-- --></A>
212<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
213<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
214<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
215<B>Method Detail</B></FONT></TH>
216</TR>
217</TABLE>
218
219<A NAME="getEnvelope()"><!-- --></A><H3>
220getEnvelope</H3>
221<PRE>
222public <A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client">Envelope</A> <B>getEnvelope</B>()</PRE>
223<DL>
224<DD>Get the <A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client"><CODE>Envelope</CODE></A> included in this response
225<P>
226<DD><DL>
227
228<DT><B>Returns:</B><DD>the envelope</DL>
229</DD>
230</DL>
231<HR>
232
233<A NAME="getProps()"><!-- --></A><H3>
234getProps</H3>
235<PRE>
236public <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A> <B>getProps</B>()</PRE>
237<DL>
238<DD>Get the <A HREF="../../../com/rabbitmq/client/BasicProperties.html" title="interface in com.rabbitmq.client"><CODE>BasicProperties</CODE></A> included in this response
239<P>
240<DD><DL>
241
242<DT><B>Returns:</B><DD>the properties</DL>
243</DD>
244</DL>
245<HR>
246
247<A NAME="getBody()"><!-- --></A><H3>
248getBody</H3>
249<PRE>
250public byte[] <B>getBody</B>()</PRE>
251<DL>
252<DD>Get the message body included in this response
253<P>
254<DD><DL>
255
256<DT><B>Returns:</B><DD>the message body</DL>
257</DD>
258</DL>
259<HR>
260
261<A NAME="getMessageCount()"><!-- --></A><H3>
262getMessageCount</H3>
263<PRE>
264public int <B>getMessageCount</B>()</PRE>
265<DL>
266<DD>Get the server's most recent estimate of the number of messages
267 remaining on the queue. This number can only ever be a rough
268 estimate, because of concurrent activity at the server and the
269 delay between the server sending its estimate and the client
270 receiving and processing the message containing the estimate.
271
272 <p>According to the AMQP specification, this figure does not
273 include the message being delivered. For example, this field
274 will be zero in the simplest case of a single reader issuing a
275 Basic.Get on a private queue holding a single message (the
276 message being delivered in this GetResponse).
277<P>
278<DD><DL>
279
280<DT><B>Returns:</B><DD>an estimate of the number of messages remaining to be
281 read from the queue</DL>
282</DD>
283</DL>
284<!-- ========= END OF CLASS DATA ========= -->
285<HR>
286
287
288<!-- ======= START OF BOTTOM NAVBAR ====== -->
289<A NAME="navbar_bottom"><!-- --></A>
290<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
291<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
292<TR>
293<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
294<A NAME="navbar_bottom_firstrow"><!-- --></A>
295<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
296  <TR ALIGN="center" VALIGN="top">
297  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
298  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
299  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
300  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
301  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
302  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
303  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
304  </TR>
305</TABLE>
306</TD>
307<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
308</EM>
309</TD>
310</TR>
311
312<TR>
313<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
314&nbsp;<A HREF="../../../com/rabbitmq/client/FlowListener.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
315&nbsp;<A HREF="../../../com/rabbitmq/client/JDKSaslConfig.html" title="class in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
316<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
317  <A HREF="../../../index.html?com/rabbitmq/client/GetResponse.html" target="_top"><B>FRAMES</B></A>  &nbsp;
318&nbsp;<A HREF="GetResponse.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
319&nbsp;<SCRIPT type="text/javascript">
320  <!--
321  if(window==top) {
322    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
323  }
324  //-->
325</SCRIPT>
326<NOSCRIPT>
327  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
328</NOSCRIPT>
329
330
331</FONT></TD>
332</TR>
333<TR>
334<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
335  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
336<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
337DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
338</TR>
339</TABLE>
340<A NAME="skip-navbar_bottom"></A>
341<!-- ======== END OF BOTTOM NAVBAR ======= -->
342
343<HR>
344
345</BODY>
346</HTML>
Note: See TracBrowser for help on using the repository browser.