source: branches/objectmq-1.0/lib/rabbitmq-java-client-javadoc-3.0.1/com/rabbitmq/client/Envelope.html

Last change on this file was 33, checked in by amoreno, 11 years ago

new release version
File size: 12.2 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>
7Envelope
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="Envelope";
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/DefaultSaslConfig.html" title="class in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../com/rabbitmq/client/FlowListener.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/Envelope.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="Envelope.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 Envelope</H2>
93<PRE>
94java.lang.Object
95  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.Envelope</B>
96</PRE>
97<HR>
98<DL>
99<DT><PRE>public class <B>Envelope</B><DT>extends java.lang.Object</DL>
100</PRE>
101
102<P>
103Encapsulates a group of parameters used for AMQP's Basic methods
104<P>
105
106<P>
107<HR>
108
109<P>
110
111<!-- ======== CONSTRUCTOR SUMMARY ======== -->
112
113<A NAME="constructor_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
117<B>Constructor Summary</B></FONT></TH>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Envelope.html#Envelope(long, boolean, java.lang.String, java.lang.String)">Envelope</A></B>(long&nbsp;deliveryTag,
121         boolean&nbsp;redeliver,
122         java.lang.String&nbsp;exchange,
123         java.lang.String&nbsp;routingKey)</CODE>
124
125<BR>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an <A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client"><CODE>Envelope</CODE></A> with the specified construction parameters</TD>
127</TR>
128</TABLE>
129&nbsp;
130<!-- ========== METHOD SUMMARY =========== -->
131
132<A NAME="method_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>Method 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>&nbsp;long</CODE></FONT></TD>
141<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Envelope.html#getDeliveryTag()">getDeliveryTag</A></B>()</CODE>
142
143<BR>
144&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the delivery tag included in this parameter envelope</TD>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
149<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Envelope.html#getExchange()">getExchange</A></B>()</CODE>
150
151<BR>
152&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of the exchange included in this parameter envelope</TD>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
157<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Envelope.html#getRoutingKey()">getRoutingKey</A></B>()</CODE>
158
159<BR>
160&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the routing key included in this parameter envelope</TD>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164<CODE>&nbsp;boolean</CODE></FONT></TD>
165<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Envelope.html#isRedeliver()">isRedeliver</A></B>()</CODE>
166
167<BR>
168&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the redelivery flag included in this parameter envelope</TD>
169</TR>
170</TABLE>
171&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
172<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
174<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
178</TR>
179</TABLE>
180&nbsp;
181<P>
182
183<!-- ========= CONSTRUCTOR DETAIL ======== -->
184
185<A NAME="constructor_detail"><!-- --></A>
186<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
187<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
188<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
189<B>Constructor Detail</B></FONT></TH>
190</TR>
191</TABLE>
192
193<A NAME="Envelope(long, boolean, java.lang.String, java.lang.String)"><!-- --></A><H3>
194Envelope</H3>
195<PRE>
196public <B>Envelope</B>(long&nbsp;deliveryTag,
197                boolean&nbsp;redeliver,
198                java.lang.String&nbsp;exchange,
199                java.lang.String&nbsp;routingKey)</PRE>
200<DL>
201<DD>Construct an <A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client"><CODE>Envelope</CODE></A> with the specified construction parameters
202<P>
203<DL>
204<DT><B>Parameters:</B><DD><CODE>deliveryTag</CODE> - the delivery tag<DD><CODE>redeliver</CODE> - true if this is a redelivery following a failed ack<DD><CODE>exchange</CODE> - the exchange used for the current operation<DD><CODE>routingKey</CODE> - the associated routing key</DL>
205</DL>
206
207<!-- ============ METHOD DETAIL ========== -->
208
209<A NAME="method_detail"><!-- --></A>
210<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
211<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
212<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
213<B>Method Detail</B></FONT></TH>
214</TR>
215</TABLE>
216
217<A NAME="getDeliveryTag()"><!-- --></A><H3>
218getDeliveryTag</H3>
219<PRE>
220public long <B>getDeliveryTag</B>()</PRE>
221<DL>
222<DD>Get the delivery tag included in this parameter envelope
223<P>
224<DD><DL>
225
226<DT><B>Returns:</B><DD>the delivery tag</DL>
227</DD>
228</DL>
229<HR>
230
231<A NAME="isRedeliver()"><!-- --></A><H3>
232isRedeliver</H3>
233<PRE>
234public boolean <B>isRedeliver</B>()</PRE>
235<DL>
236<DD>Get the redelivery flag included in this parameter envelope
237<P>
238<DD><DL>
239
240<DT><B>Returns:</B><DD>the redelivery flag</DL>
241</DD>
242</DL>
243<HR>
244
245<A NAME="getExchange()"><!-- --></A><H3>
246getExchange</H3>
247<PRE>
248public java.lang.String <B>getExchange</B>()</PRE>
249<DL>
250<DD>Get the name of the exchange included in this parameter envelope
251<P>
252<DD><DL>
253
254<DT><B>Returns:</B><DD>the exchange</DL>
255</DD>
256</DL>
257<HR>
258
259<A NAME="getRoutingKey()"><!-- --></A><H3>
260getRoutingKey</H3>
261<PRE>
262public java.lang.String <B>getRoutingKey</B>()</PRE>
263<DL>
264<DD>Get the routing key included in this parameter envelope
265<P>
266<DD><DL>
267
268<DT><B>Returns:</B><DD>the routing key</DL>
269</DD>
270</DL>
271<!-- ========= END OF CLASS DATA ========= -->
272<HR>
273
274
275<!-- ======= START OF BOTTOM NAVBAR ====== -->
276<A NAME="navbar_bottom"><!-- --></A>
277<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
278<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
279<TR>
280<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
281<A NAME="navbar_bottom_firstrow"><!-- --></A>
282<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
283  <TR ALIGN="center" VALIGN="top">
284  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
285  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
286  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
287  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
288  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
289  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
290  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
291  </TR>
292</TABLE>
293</TD>
294<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
295</EM>
296</TD>
297</TR>
298
299<TR>
300<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
301&nbsp;<A HREF="../../../com/rabbitmq/client/DefaultSaslConfig.html" title="class in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
302&nbsp;<A HREF="../../../com/rabbitmq/client/FlowListener.html" title="interface in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
303<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
304  <A HREF="../../../index.html?com/rabbitmq/client/Envelope.html" target="_top"><B>FRAMES</B></A>  &nbsp;
305&nbsp;<A HREF="Envelope.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
306&nbsp;<SCRIPT type="text/javascript">
307  <!--
308  if(window==top) {
309    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
310  }
311  //-->
312</SCRIPT>
313<NOSCRIPT>
314  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
315</NOSCRIPT>
316
317
318</FONT></TD>
319</TR>
320<TR>
321<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
322  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
323<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
324DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
325</TR>
326</TABLE>
327<A NAME="skip-navbar_bottom"></A>
328<!-- ======== END OF BOTTOM NAVBAR ======= -->
329
330<HR>
331
332</BODY>
333</HTML>
Note: See TracBrowser for help on using the repository browser.