[33] | 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> |
---|
| 7 | DefaultConsumer |
---|
| 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"> |
---|
| 15 | function windowTitle() |
---|
| 16 | { |
---|
| 17 | if (location.href.indexOf('is-external=true') == -1) { |
---|
| 18 | parent.document.title="DefaultConsumer"; |
---|
| 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> </TD> |
---|
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 42 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 43 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
| 46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../com/rabbitmq/client/ContentHeader.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A> |
---|
| 58 | <A HREF="../../../com/rabbitmq/client/DefaultSaslConfig.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/DefaultConsumer.html" target="_top"><B>FRAMES</B></A> |
---|
| 61 | <A HREF="DefaultConsumer.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 62 | <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: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 79 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 80 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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"> |
---|
| 90 | com.rabbitmq.client</FONT> |
---|
| 91 | <BR> |
---|
| 92 | Class DefaultConsumer</H2> |
---|
| 93 | <PRE> |
---|
| 94 | java.lang.Object |
---|
| 95 | <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.DefaultConsumer</B> |
---|
| 96 | </PRE> |
---|
| 97 | <DL> |
---|
| 98 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/rabbitmq/client/Consumer.html" title="interface in com.rabbitmq.client">Consumer</A></DD> |
---|
| 99 | </DL> |
---|
| 100 | <DL> |
---|
| 101 | <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/rabbitmq/client/QueueingConsumer.html" title="class in com.rabbitmq.client">QueueingConsumer</A></DD> |
---|
| 102 | </DL> |
---|
| 103 | <HR> |
---|
| 104 | <DL> |
---|
| 105 | <DT><PRE>public class <B>DefaultConsumer</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../com/rabbitmq/client/Consumer.html" title="interface in com.rabbitmq.client">Consumer</A></DL> |
---|
| 106 | </PRE> |
---|
| 107 | |
---|
| 108 | <P> |
---|
| 109 | Convenience class providing a default implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html" title="interface in com.rabbitmq.client"><CODE>Consumer</CODE></A>. |
---|
| 110 | We anticipate that most Consumer implementations will subclass this class. |
---|
| 111 | <P> |
---|
| 112 | |
---|
| 113 | <P> |
---|
| 114 | <HR> |
---|
| 115 | |
---|
| 116 | <P> |
---|
| 117 | |
---|
| 118 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
| 119 | |
---|
| 120 | <A NAME="constructor_summary"><!-- --></A> |
---|
| 121 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 122 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 123 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 124 | <B>Constructor Summary</B></FONT></TH> |
---|
| 125 | </TR> |
---|
| 126 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 127 | <TD><CODE><B><A HREF="../../../com/rabbitmq/client/DefaultConsumer.html#DefaultConsumer(com.rabbitmq.client.Channel)">DefaultConsumer</A></B>(<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A> channel)</CODE> |
---|
| 128 | |
---|
| 129 | <BR> |
---|
| 130 | Constructs a new instance and records its association to the passed-in channel.</TD> |
---|
| 131 | </TR> |
---|
| 132 | </TABLE> |
---|
| 133 | |
---|
| 134 | <!-- ========== METHOD SUMMARY =========== --> |
---|
| 135 | |
---|
| 136 | <A NAME="method_summary"><!-- --></A> |
---|
| 137 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 138 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 139 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 140 | <B>Method Summary</B></FONT></TH> |
---|
| 141 | </TR> |
---|
| 142 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 143 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 144 | <CODE> <A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A></CODE></FONT></TD> |
---|
| 145 | <TD><CODE><B><A HREF="../../../com/rabbitmq/client/DefaultConsumer.html#getChannel()">getChannel</A></B>()</CODE> |
---|
| 146 | |
---|
| 147 | <BR> |
---|
| 148 | Retrieve the channel.</TD> |
---|
| 149 | </TR> |
---|
| 150 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 151 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 152 | <CODE> java.lang.String</CODE></FONT></TD> |
---|
| 153 | <TD><CODE><B><A HREF="../../../com/rabbitmq/client/DefaultConsumer.html#getConsumerTag()">getConsumerTag</A></B>()</CODE> |
---|
| 154 | |
---|
| 155 | <BR> |
---|
| 156 | Retrieve the consumer tag.</TD> |
---|
| 157 | </TR> |
---|
| 158 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 159 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 160 | <CODE> void</CODE></FONT></TD> |
---|
| 161 | <TD><CODE><B><A HREF="../../../com/rabbitmq/client/DefaultConsumer.html#handleCancel(java.lang.String)">handleCancel</A></B>(java.lang.String consumerTag)</CODE> |
---|
| 162 | |
---|
| 163 | <BR> |
---|
| 164 | No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleCancel(java.lang.String)"><CODE>Consumer.handleCancel(String)</CODE></A></TD> |
---|
| 165 | </TR> |
---|
| 166 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 167 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 168 | <CODE> void</CODE></FONT></TD> |
---|
| 169 | <TD><CODE><B><A HREF="../../../com/rabbitmq/client/DefaultConsumer.html#handleCancelOk(java.lang.String)">handleCancelOk</A></B>(java.lang.String consumerTag)</CODE> |
---|
| 170 | |
---|
| 171 | <BR> |
---|
| 172 | No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleCancelOk(java.lang.String)"><CODE>Consumer.handleCancelOk(java.lang.String)</CODE></A>.</TD> |
---|
| 173 | </TR> |
---|
| 174 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 175 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 176 | <CODE> void</CODE></FONT></TD> |
---|
| 177 | <TD><CODE><B><A HREF="../../../com/rabbitmq/client/DefaultConsumer.html#handleConsumeOk(java.lang.String)">handleConsumeOk</A></B>(java.lang.String consumerTag)</CODE> |
---|
| 178 | |
---|
| 179 | <BR> |
---|
| 180 | Stores the most recently passed-in consumerTag - semantically, there should be only one.</TD> |
---|
| 181 | </TR> |
---|
| 182 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 183 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 184 | <CODE> void</CODE></FONT></TD> |
---|
| 185 | <TD><CODE><B><A HREF="../../../com/rabbitmq/client/DefaultConsumer.html#handleDelivery(java.lang.String, com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[])">handleDelivery</A></B>(java.lang.String consumerTag, |
---|
| 186 | <A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client">Envelope</A> envelope, |
---|
| 187 | <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A> properties, |
---|
| 188 | byte[] body)</CODE> |
---|
| 189 | |
---|
| 190 | <BR> |
---|
| 191 | No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleDelivery(java.lang.String, com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[])"><CODE>Consumer.handleDelivery(java.lang.String, com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[])</CODE></A>.</TD> |
---|
| 192 | </TR> |
---|
| 193 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 194 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 195 | <CODE> void</CODE></FONT></TD> |
---|
| 196 | <TD><CODE><B><A HREF="../../../com/rabbitmq/client/DefaultConsumer.html#handleRecoverOk(java.lang.String)">handleRecoverOk</A></B>(java.lang.String consumerTag)</CODE> |
---|
| 197 | |
---|
| 198 | <BR> |
---|
| 199 | No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleRecoverOk(java.lang.String)"><CODE>Consumer.handleRecoverOk(java.lang.String)</CODE></A>.</TD> |
---|
| 200 | </TR> |
---|
| 201 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 202 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 203 | <CODE> void</CODE></FONT></TD> |
---|
| 204 | <TD><CODE><B><A HREF="../../../com/rabbitmq/client/DefaultConsumer.html#handleShutdownSignal(java.lang.String, com.rabbitmq.client.ShutdownSignalException)">handleShutdownSignal</A></B>(java.lang.String consumerTag, |
---|
| 205 | <A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A> sig)</CODE> |
---|
| 206 | |
---|
| 207 | <BR> |
---|
| 208 | No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleShutdownSignal(java.lang.String, com.rabbitmq.client.ShutdownSignalException)"><CODE>Consumer.handleShutdownSignal(java.lang.String, com.rabbitmq.client.ShutdownSignalException)</CODE></A>.</TD> |
---|
| 209 | </TR> |
---|
| 210 | </TABLE> |
---|
| 211 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
| 212 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 213 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 214 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
---|
| 215 | </TR> |
---|
| 216 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 217 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
---|
| 218 | </TR> |
---|
| 219 | </TABLE> |
---|
| 220 | |
---|
| 221 | <P> |
---|
| 222 | |
---|
| 223 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
| 224 | |
---|
| 225 | <A NAME="constructor_detail"><!-- --></A> |
---|
| 226 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 227 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 228 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 229 | <B>Constructor Detail</B></FONT></TH> |
---|
| 230 | </TR> |
---|
| 231 | </TABLE> |
---|
| 232 | |
---|
| 233 | <A NAME="DefaultConsumer(com.rabbitmq.client.Channel)"><!-- --></A><H3> |
---|
| 234 | DefaultConsumer</H3> |
---|
| 235 | <PRE> |
---|
| 236 | public <B>DefaultConsumer</B>(<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A> channel)</PRE> |
---|
| 237 | <DL> |
---|
| 238 | <DD>Constructs a new instance and records its association to the passed-in channel. |
---|
| 239 | <P> |
---|
| 240 | <DL> |
---|
| 241 | <DT><B>Parameters:</B><DD><CODE>channel</CODE> - the channel to which this consumer is attached</DL> |
---|
| 242 | </DL> |
---|
| 243 | |
---|
| 244 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 245 | |
---|
| 246 | <A NAME="method_detail"><!-- --></A> |
---|
| 247 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 248 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 249 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 250 | <B>Method Detail</B></FONT></TH> |
---|
| 251 | </TR> |
---|
| 252 | </TABLE> |
---|
| 253 | |
---|
| 254 | <A NAME="handleConsumeOk(java.lang.String)"><!-- --></A><H3> |
---|
| 255 | handleConsumeOk</H3> |
---|
| 256 | <PRE> |
---|
| 257 | public void <B>handleConsumeOk</B>(java.lang.String consumerTag)</PRE> |
---|
| 258 | <DL> |
---|
| 259 | <DD>Stores the most recently passed-in consumerTag - semantically, there should be only one. |
---|
| 260 | <P> |
---|
| 261 | <DD><DL> |
---|
| 262 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/rabbitmq/client/Consumer.html#handleConsumeOk(java.lang.String)">handleConsumeOk</A></CODE> in interface <CODE><A HREF="../../../com/rabbitmq/client/Consumer.html" title="interface in com.rabbitmq.client">Consumer</A></CODE></DL> |
---|
| 263 | </DD> |
---|
| 264 | <DD><DL> |
---|
| 265 | <DT><B>Parameters:</B><DD><CODE>consumerTag</CODE> - the <i>consumer tag</i> associated with the consumer<DT><B>See Also:</B><DD><A HREF="../../../com/rabbitmq/client/Consumer.html#handleConsumeOk(java.lang.String)"><CODE>Consumer.handleConsumeOk(java.lang.String)</CODE></A></DL> |
---|
| 266 | </DD> |
---|
| 267 | </DL> |
---|
| 268 | <HR> |
---|
| 269 | |
---|
| 270 | <A NAME="handleCancelOk(java.lang.String)"><!-- --></A><H3> |
---|
| 271 | handleCancelOk</H3> |
---|
| 272 | <PRE> |
---|
| 273 | public void <B>handleCancelOk</B>(java.lang.String consumerTag)</PRE> |
---|
| 274 | <DL> |
---|
| 275 | <DD>No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleCancelOk(java.lang.String)"><CODE>Consumer.handleCancelOk(java.lang.String)</CODE></A>. |
---|
| 276 | <P> |
---|
| 277 | <DD><DL> |
---|
| 278 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/rabbitmq/client/Consumer.html#handleCancelOk(java.lang.String)">handleCancelOk</A></CODE> in interface <CODE><A HREF="../../../com/rabbitmq/client/Consumer.html" title="interface in com.rabbitmq.client">Consumer</A></CODE></DL> |
---|
| 279 | </DD> |
---|
| 280 | <DD><DL> |
---|
| 281 | <DT><B>Parameters:</B><DD><CODE>consumerTag</CODE> - the defined consumer tag (client- or server-generated)</DL> |
---|
| 282 | </DD> |
---|
| 283 | </DL> |
---|
| 284 | <HR> |
---|
| 285 | |
---|
| 286 | <A NAME="handleCancel(java.lang.String)"><!-- --></A><H3> |
---|
| 287 | handleCancel</H3> |
---|
| 288 | <PRE> |
---|
| 289 | public void <B>handleCancel</B>(java.lang.String consumerTag) |
---|
| 290 | throws java.io.IOException</PRE> |
---|
| 291 | <DL> |
---|
| 292 | <DD>No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleCancel(java.lang.String)"><CODE>Consumer.handleCancel(String)</CODE></A> |
---|
| 293 | <P> |
---|
| 294 | <DD><DL> |
---|
| 295 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/rabbitmq/client/Consumer.html#handleCancel(java.lang.String)">handleCancel</A></CODE> in interface <CODE><A HREF="../../../com/rabbitmq/client/Consumer.html" title="interface in com.rabbitmq.client">Consumer</A></CODE></DL> |
---|
| 296 | </DD> |
---|
| 297 | <DD><DL> |
---|
| 298 | <DT><B>Parameters:</B><DD><CODE>consumerTag</CODE> - the defined consumer tag (client- or server-generated) |
---|
| 299 | <DT><B>Throws:</B> |
---|
| 300 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
| 301 | </DD> |
---|
| 302 | </DL> |
---|
| 303 | <HR> |
---|
| 304 | |
---|
| 305 | <A NAME="handleShutdownSignal(java.lang.String, com.rabbitmq.client.ShutdownSignalException)"><!-- --></A><H3> |
---|
| 306 | handleShutdownSignal</H3> |
---|
| 307 | <PRE> |
---|
| 308 | public void <B>handleShutdownSignal</B>(java.lang.String consumerTag, |
---|
| 309 | <A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A> sig)</PRE> |
---|
| 310 | <DL> |
---|
| 311 | <DD>No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleShutdownSignal(java.lang.String, com.rabbitmq.client.ShutdownSignalException)"><CODE>Consumer.handleShutdownSignal(java.lang.String, com.rabbitmq.client.ShutdownSignalException)</CODE></A>. |
---|
| 312 | <P> |
---|
| 313 | <DD><DL> |
---|
| 314 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/rabbitmq/client/Consumer.html#handleShutdownSignal(java.lang.String, com.rabbitmq.client.ShutdownSignalException)">handleShutdownSignal</A></CODE> in interface <CODE><A HREF="../../../com/rabbitmq/client/Consumer.html" title="interface in com.rabbitmq.client">Consumer</A></CODE></DL> |
---|
| 315 | </DD> |
---|
| 316 | <DD><DL> |
---|
| 317 | <DT><B>Parameters:</B><DD><CODE>consumerTag</CODE> - the <i>consumer tag</i> associated with the consumer<DD><CODE>sig</CODE> - a <A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client"><CODE>ShutdownSignalException</CODE></A> indicating the reason for the shut down</DL> |
---|
| 318 | </DD> |
---|
| 319 | </DL> |
---|
| 320 | <HR> |
---|
| 321 | |
---|
| 322 | <A NAME="handleRecoverOk(java.lang.String)"><!-- --></A><H3> |
---|
| 323 | handleRecoverOk</H3> |
---|
| 324 | <PRE> |
---|
| 325 | public void <B>handleRecoverOk</B>(java.lang.String consumerTag)</PRE> |
---|
| 326 | <DL> |
---|
| 327 | <DD>No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleRecoverOk(java.lang.String)"><CODE>Consumer.handleRecoverOk(java.lang.String)</CODE></A>. |
---|
| 328 | <P> |
---|
| 329 | <DD><DL> |
---|
| 330 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/rabbitmq/client/Consumer.html#handleRecoverOk(java.lang.String)">handleRecoverOk</A></CODE> in interface <CODE><A HREF="../../../com/rabbitmq/client/Consumer.html" title="interface in com.rabbitmq.client">Consumer</A></CODE></DL> |
---|
| 331 | </DD> |
---|
| 332 | <DD><DL> |
---|
| 333 | <DT><B>Parameters:</B><DD><CODE>consumerTag</CODE> - the <i>consumer tag</i> associated with the consumer</DL> |
---|
| 334 | </DD> |
---|
| 335 | </DL> |
---|
| 336 | <HR> |
---|
| 337 | |
---|
| 338 | <A NAME="handleDelivery(java.lang.String, com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[])"><!-- --></A><H3> |
---|
| 339 | handleDelivery</H3> |
---|
| 340 | <PRE> |
---|
| 341 | public void <B>handleDelivery</B>(java.lang.String consumerTag, |
---|
| 342 | <A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client">Envelope</A> envelope, |
---|
| 343 | <A HREF="../../../com/rabbitmq/client/AMQP.BasicProperties.html" title="class in com.rabbitmq.client">AMQP.BasicProperties</A> properties, |
---|
| 344 | byte[] body) |
---|
| 345 | throws java.io.IOException</PRE> |
---|
| 346 | <DL> |
---|
| 347 | <DD>No-op implementation of <A HREF="../../../com/rabbitmq/client/Consumer.html#handleDelivery(java.lang.String, com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[])"><CODE>Consumer.handleDelivery(java.lang.String, com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[])</CODE></A>. |
---|
| 348 | <P> |
---|
| 349 | <DD><DL> |
---|
| 350 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/rabbitmq/client/Consumer.html#handleDelivery(java.lang.String, com.rabbitmq.client.Envelope, com.rabbitmq.client.AMQP.BasicProperties, byte[])">handleDelivery</A></CODE> in interface <CODE><A HREF="../../../com/rabbitmq/client/Consumer.html" title="interface in com.rabbitmq.client">Consumer</A></CODE></DL> |
---|
| 351 | </DD> |
---|
| 352 | <DD><DL> |
---|
| 353 | <DT><B>Parameters:</B><DD><CODE>consumerTag</CODE> - the <i>consumer tag</i> associated with the consumer<DD><CODE>envelope</CODE> - packaging data for the message<DD><CODE>properties</CODE> - content header data for the message<DD><CODE>body</CODE> - the message body (opaque, client-specific byte array) |
---|
| 354 | <DT><B>Throws:</B> |
---|
| 355 | <DD><CODE>java.io.IOException</CODE> - if the consumer encounters an I/O error while processing the message<DT><B>See Also:</B><DD><A HREF="../../../com/rabbitmq/client/Envelope.html" title="class in com.rabbitmq.client"><CODE>Envelope</CODE></A></DL> |
---|
| 356 | </DD> |
---|
| 357 | </DL> |
---|
| 358 | <HR> |
---|
| 359 | |
---|
| 360 | <A NAME="getChannel()"><!-- --></A><H3> |
---|
| 361 | getChannel</H3> |
---|
| 362 | <PRE> |
---|
| 363 | public <A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A> <B>getChannel</B>()</PRE> |
---|
| 364 | <DL> |
---|
| 365 | <DD>Retrieve the channel. |
---|
| 366 | <P> |
---|
| 367 | <DD><DL> |
---|
| 368 | </DL> |
---|
| 369 | </DD> |
---|
| 370 | <DD><DL> |
---|
| 371 | |
---|
| 372 | <DT><B>Returns:</B><DD>the channel this consumer is attached to.</DL> |
---|
| 373 | </DD> |
---|
| 374 | </DL> |
---|
| 375 | <HR> |
---|
| 376 | |
---|
| 377 | <A NAME="getConsumerTag()"><!-- --></A><H3> |
---|
| 378 | getConsumerTag</H3> |
---|
| 379 | <PRE> |
---|
| 380 | public java.lang.String <B>getConsumerTag</B>()</PRE> |
---|
| 381 | <DL> |
---|
| 382 | <DD>Retrieve the consumer tag. |
---|
| 383 | <P> |
---|
| 384 | <DD><DL> |
---|
| 385 | </DL> |
---|
| 386 | </DD> |
---|
| 387 | <DD><DL> |
---|
| 388 | |
---|
| 389 | <DT><B>Returns:</B><DD>the most recently notified consumer tag.</DL> |
---|
| 390 | </DD> |
---|
| 391 | </DL> |
---|
| 392 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 393 | <HR> |
---|
| 394 | |
---|
| 395 | |
---|
| 396 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
| 397 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 398 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
| 399 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 400 | <TR> |
---|
| 401 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 402 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 403 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 404 | <TR ALIGN="center" VALIGN="top"> |
---|
| 405 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 406 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 407 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 408 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 409 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 410 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
| 411 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 412 | </TR> |
---|
| 413 | </TABLE> |
---|
| 414 | </TD> |
---|
| 415 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 416 | </EM> |
---|
| 417 | </TD> |
---|
| 418 | </TR> |
---|
| 419 | |
---|
| 420 | <TR> |
---|
| 421 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 422 | <A HREF="../../../com/rabbitmq/client/ContentHeader.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A> |
---|
| 423 | <A HREF="../../../com/rabbitmq/client/DefaultSaslConfig.html" title="class in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 424 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 425 | <A HREF="../../../index.html?com/rabbitmq/client/DefaultConsumer.html" target="_top"><B>FRAMES</B></A> |
---|
| 426 | <A HREF="DefaultConsumer.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 427 | <SCRIPT type="text/javascript"> |
---|
| 428 | <!-- |
---|
| 429 | if(window==top) { |
---|
| 430 | document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 431 | } |
---|
| 432 | //--> |
---|
| 433 | </SCRIPT> |
---|
| 434 | <NOSCRIPT> |
---|
| 435 | <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 436 | </NOSCRIPT> |
---|
| 437 | |
---|
| 438 | |
---|
| 439 | </FONT></TD> |
---|
| 440 | </TR> |
---|
| 441 | <TR> |
---|
| 442 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 443 | SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 444 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 445 | DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 446 | </TR> |
---|
| 447 | </TABLE> |
---|
| 448 | <A NAME="skip-navbar_bottom"></A> |
---|
| 449 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
| 450 | |
---|
| 451 | <HR> |
---|
| 452 | |
---|
| 453 | </BODY> |
---|
| 454 | </HTML> |
---|