[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:11 GMT 2012 --> |
---|
| 6 | <TITLE> |
---|
| 7 | Frame |
---|
| 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="Frame"; |
---|
| 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/impl/ExternalMechanism.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A> |
---|
| 58 | <A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 59 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 60 | <A HREF="../../../../index.html?com/rabbitmq/client/impl/Frame.html" target="_top"><B>FRAMES</B></A> |
---|
| 61 | <A HREF="Frame.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 | <A HREF="#field_summary">FIELD</A> | <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: <A HREF="#field_detail">FIELD</A> | <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.impl</FONT> |
---|
| 91 | <BR> |
---|
| 92 | Class Frame</H2> |
---|
| 93 | <PRE> |
---|
| 94 | java.lang.Object |
---|
| 95 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.impl.Frame</B> |
---|
| 96 | </PRE> |
---|
| 97 | <HR> |
---|
| 98 | <DL> |
---|
| 99 | <DT><PRE>public class <B>Frame</B><DT>extends java.lang.Object</DL> |
---|
| 100 | </PRE> |
---|
| 101 | |
---|
| 102 | <P> |
---|
| 103 | Represents an AMQP wire-protocol frame, with frame type, channel number, and payload bytes. |
---|
| 104 | TODO: make state private |
---|
| 105 | <P> |
---|
| 106 | |
---|
| 107 | <P> |
---|
| 108 | <HR> |
---|
| 109 | |
---|
| 110 | <P> |
---|
| 111 | <!-- =========== FIELD SUMMARY =========== --> |
---|
| 112 | |
---|
| 113 | <A NAME="field_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>Field Summary</B></FONT></TH> |
---|
| 118 | </TR> |
---|
| 119 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 120 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 121 | <CODE> int</CODE></FONT></TD> |
---|
| 122 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#channel">channel</A></B></CODE> |
---|
| 123 | |
---|
| 124 | <BR> |
---|
| 125 | Frame channel number, 0-65535</TD> |
---|
| 126 | </TR> |
---|
| 127 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 128 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 129 | <CODE> int</CODE></FONT></TD> |
---|
| 130 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#type">type</A></B></CODE> |
---|
| 131 | |
---|
| 132 | <BR> |
---|
| 133 | Frame type code</TD> |
---|
| 134 | </TR> |
---|
| 135 | </TABLE> |
---|
| 136 | |
---|
| 137 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
| 138 | |
---|
| 139 | <A NAME="constructor_summary"><!-- --></A> |
---|
| 140 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 141 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 142 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 143 | <B>Constructor Summary</B></FONT></TH> |
---|
| 144 | </TR> |
---|
| 145 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 146 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#Frame(int, int)">Frame</A></B>(int type, |
---|
| 147 | int channel)</CODE> |
---|
| 148 | |
---|
| 149 | <BR> |
---|
| 150 | Constructs a frame for output with a type and a channel number and a |
---|
| 151 | fresh accumulator waiting for payload.</TD> |
---|
| 152 | </TR> |
---|
| 153 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 154 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#Frame(int, int, byte[])">Frame</A></B>(int type, |
---|
| 155 | int channel, |
---|
| 156 | byte[] payload)</CODE> |
---|
| 157 | |
---|
| 158 | <BR> |
---|
| 159 | Constructs a frame for input with a type, a channel number and a |
---|
| 160 | payload byte array.</TD> |
---|
| 161 | </TR> |
---|
| 162 | </TABLE> |
---|
| 163 | |
---|
| 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>static long</CODE></FONT></TD> |
---|
| 175 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#arraySize(java.util.List)">arraySize</A></B>(java.util.List<?> values)</CODE> |
---|
| 176 | |
---|
| 177 | <BR> |
---|
| 178 | Computes the AMQP wire-protocol length of an encoded field-array of type List<?></TD> |
---|
| 179 | </TR> |
---|
| 180 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 181 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 182 | <CODE>static long</CODE></FONT></TD> |
---|
| 183 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#arraySize(java.lang.Object[])">arraySize</A></B>(java.lang.Object[] values)</CODE> |
---|
| 184 | |
---|
| 185 | <BR> |
---|
| 186 | Computes the AMQP wire-protocol length of an encoded field-array of type Object[]</TD> |
---|
| 187 | </TR> |
---|
| 188 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 189 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 190 | <CODE>static <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A></CODE></FONT></TD> |
---|
| 191 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#fromBodyFragment(int, byte[], int, int)">fromBodyFragment</A></B>(int channelNumber, |
---|
| 192 | byte[] body, |
---|
| 193 | int offset, |
---|
| 194 | int length)</CODE> |
---|
| 195 | |
---|
| 196 | <BR> |
---|
| 197 | </TD> |
---|
| 198 | </TR> |
---|
| 199 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 200 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 201 | <CODE> java.io.DataInputStream</CODE></FONT></TD> |
---|
| 202 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#getInputStream()">getInputStream</A></B>()</CODE> |
---|
| 203 | |
---|
| 204 | <BR> |
---|
| 205 | Public API - retrieves a new DataInputStream streaming over the payload</TD> |
---|
| 206 | </TR> |
---|
| 207 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 208 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 209 | <CODE> java.io.DataOutputStream</CODE></FONT></TD> |
---|
| 210 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#getOutputStream()">getOutputStream</A></B>()</CODE> |
---|
| 211 | |
---|
| 212 | <BR> |
---|
| 213 | Public API - retrieves a fresh DataOutputStream streaming into the accumulator</TD> |
---|
| 214 | </TR> |
---|
| 215 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 216 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 217 | <CODE> byte[]</CODE></FONT></TD> |
---|
| 218 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#getPayload()">getPayload</A></B>()</CODE> |
---|
| 219 | |
---|
| 220 | <BR> |
---|
| 221 | Public API - retrieves the frame payload</TD> |
---|
| 222 | </TR> |
---|
| 223 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 224 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 225 | <CODE>static void</CODE></FONT></TD> |
---|
| 226 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#protocolVersionMismatch(java.io.DataInputStream)">protocolVersionMismatch</A></B>(java.io.DataInputStream is)</CODE> |
---|
| 227 | |
---|
| 228 | <BR> |
---|
| 229 | Private API - A protocol version mismatch is detected by checking the |
---|
| 230 | three next bytes if a frame type of (int)'A' is read from an input |
---|
| 231 | stream.</TD> |
---|
| 232 | </TR> |
---|
| 233 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 234 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 235 | <CODE>static <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A></CODE></FONT></TD> |
---|
| 236 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#readFrom(java.io.DataInputStream)">readFrom</A></B>(java.io.DataInputStream is)</CODE> |
---|
| 237 | |
---|
| 238 | <BR> |
---|
| 239 | Protected API - Factory method to instantiate a Frame by reading an |
---|
| 240 | AMQP-wire-protocol frame from the given input stream.</TD> |
---|
| 241 | </TR> |
---|
| 242 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 243 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 244 | <CODE>static long</CODE></FONT></TD> |
---|
| 245 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#tableSize(java.util.Map)">tableSize</A></B>(java.util.Map<java.lang.String,java.lang.Object> table)</CODE> |
---|
| 246 | |
---|
| 247 | <BR> |
---|
| 248 | Computes the AMQP wire-protocol length of protocol-encoded table entries.</TD> |
---|
| 249 | </TR> |
---|
| 250 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 251 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 252 | <CODE> java.lang.String</CODE></FONT></TD> |
---|
| 253 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#toString()">toString</A></B>()</CODE> |
---|
| 254 | |
---|
| 255 | <BR> |
---|
| 256 | </TD> |
---|
| 257 | </TR> |
---|
| 258 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 259 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 260 | <CODE> void</CODE></FONT></TD> |
---|
| 261 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/Frame.html#writeTo(java.io.DataOutputStream)">writeTo</A></B>(java.io.DataOutputStream os)</CODE> |
---|
| 262 | |
---|
| 263 | <BR> |
---|
| 264 | Public API - writes this Frame to the given DataOutputStream</TD> |
---|
| 265 | </TR> |
---|
| 266 | </TABLE> |
---|
| 267 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
| 268 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 269 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 270 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
---|
| 271 | </TR> |
---|
| 272 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 273 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> |
---|
| 274 | </TR> |
---|
| 275 | </TABLE> |
---|
| 276 | |
---|
| 277 | <P> |
---|
| 278 | |
---|
| 279 | <!-- ============ FIELD DETAIL =========== --> |
---|
| 280 | |
---|
| 281 | <A NAME="field_detail"><!-- --></A> |
---|
| 282 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 283 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 284 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 285 | <B>Field Detail</B></FONT></TH> |
---|
| 286 | </TR> |
---|
| 287 | </TABLE> |
---|
| 288 | |
---|
| 289 | <A NAME="type"><!-- --></A><H3> |
---|
| 290 | type</H3> |
---|
| 291 | <PRE> |
---|
| 292 | public final int <B>type</B></PRE> |
---|
| 293 | <DL> |
---|
| 294 | <DD>Frame type code |
---|
| 295 | <P> |
---|
| 296 | <DL> |
---|
| 297 | </DL> |
---|
| 298 | </DL> |
---|
| 299 | <HR> |
---|
| 300 | |
---|
| 301 | <A NAME="channel"><!-- --></A><H3> |
---|
| 302 | channel</H3> |
---|
| 303 | <PRE> |
---|
| 304 | public final int <B>channel</B></PRE> |
---|
| 305 | <DL> |
---|
| 306 | <DD>Frame channel number, 0-65535 |
---|
| 307 | <P> |
---|
| 308 | <DL> |
---|
| 309 | </DL> |
---|
| 310 | </DL> |
---|
| 311 | |
---|
| 312 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
| 313 | |
---|
| 314 | <A NAME="constructor_detail"><!-- --></A> |
---|
| 315 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 316 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 317 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 318 | <B>Constructor Detail</B></FONT></TH> |
---|
| 319 | </TR> |
---|
| 320 | </TABLE> |
---|
| 321 | |
---|
| 322 | <A NAME="Frame(int, int)"><!-- --></A><H3> |
---|
| 323 | Frame</H3> |
---|
| 324 | <PRE> |
---|
| 325 | public <B>Frame</B>(int type, |
---|
| 326 | int channel)</PRE> |
---|
| 327 | <DL> |
---|
| 328 | <DD>Constructs a frame for output with a type and a channel number and a |
---|
| 329 | fresh accumulator waiting for payload. |
---|
| 330 | <P> |
---|
| 331 | </DL> |
---|
| 332 | <HR> |
---|
| 333 | |
---|
| 334 | <A NAME="Frame(int, int, byte[])"><!-- --></A><H3> |
---|
| 335 | Frame</H3> |
---|
| 336 | <PRE> |
---|
| 337 | public <B>Frame</B>(int type, |
---|
| 338 | int channel, |
---|
| 339 | byte[] payload)</PRE> |
---|
| 340 | <DL> |
---|
| 341 | <DD>Constructs a frame for input with a type, a channel number and a |
---|
| 342 | payload byte array. |
---|
| 343 | <P> |
---|
| 344 | </DL> |
---|
| 345 | |
---|
| 346 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 347 | |
---|
| 348 | <A NAME="method_detail"><!-- --></A> |
---|
| 349 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 350 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 351 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 352 | <B>Method Detail</B></FONT></TH> |
---|
| 353 | </TR> |
---|
| 354 | </TABLE> |
---|
| 355 | |
---|
| 356 | <A NAME="fromBodyFragment(int, byte[], int, int)"><!-- --></A><H3> |
---|
| 357 | fromBodyFragment</H3> |
---|
| 358 | <PRE> |
---|
| 359 | public static <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A> <B>fromBodyFragment</B>(int channelNumber, |
---|
| 360 | byte[] body, |
---|
| 361 | int offset, |
---|
| 362 | int length) |
---|
| 363 | throws java.io.IOException</PRE> |
---|
| 364 | <DL> |
---|
| 365 | <DD><DL> |
---|
| 366 | |
---|
| 367 | <DT><B>Throws:</B> |
---|
| 368 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
| 369 | </DD> |
---|
| 370 | </DL> |
---|
| 371 | <HR> |
---|
| 372 | |
---|
| 373 | <A NAME="readFrom(java.io.DataInputStream)"><!-- --></A><H3> |
---|
| 374 | readFrom</H3> |
---|
| 375 | <PRE> |
---|
| 376 | public static <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A> <B>readFrom</B>(java.io.DataInputStream is) |
---|
| 377 | throws java.io.IOException</PRE> |
---|
| 378 | <DL> |
---|
| 379 | <DD>Protected API - Factory method to instantiate a Frame by reading an |
---|
| 380 | AMQP-wire-protocol frame from the given input stream. |
---|
| 381 | <P> |
---|
| 382 | <DD><DL> |
---|
| 383 | |
---|
| 384 | <DT><B>Returns:</B><DD>a new Frame if we read a frame successfully, otherwise null |
---|
| 385 | <DT><B>Throws:</B> |
---|
| 386 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
| 387 | </DD> |
---|
| 388 | </DL> |
---|
| 389 | <HR> |
---|
| 390 | |
---|
| 391 | <A NAME="protocolVersionMismatch(java.io.DataInputStream)"><!-- --></A><H3> |
---|
| 392 | protocolVersionMismatch</H3> |
---|
| 393 | <PRE> |
---|
| 394 | public static void <B>protocolVersionMismatch</B>(java.io.DataInputStream is) |
---|
| 395 | throws java.io.IOException</PRE> |
---|
| 396 | <DL> |
---|
| 397 | <DD>Private API - A protocol version mismatch is detected by checking the |
---|
| 398 | three next bytes if a frame type of (int)'A' is read from an input |
---|
| 399 | stream. If the next three bytes are 'M', 'Q' and 'P', then it's |
---|
| 400 | likely the broker is trying to tell us we are speaking the wrong AMQP |
---|
| 401 | protocol version. |
---|
| 402 | <P> |
---|
| 403 | <DD><DL> |
---|
| 404 | |
---|
| 405 | <DT><B>Throws:</B> |
---|
| 406 | <DD><CODE><A HREF="../../../../com/rabbitmq/client/MalformedFrameException.html" title="class in com.rabbitmq.client">MalformedFrameException</A></CODE> - if an AMQP protocol version mismatch is detected |
---|
| 407 | <DD><CODE><A HREF="../../../../com/rabbitmq/client/MalformedFrameException.html" title="class in com.rabbitmq.client">MalformedFrameException</A></CODE> - if a corrupt AMQP protocol identifier is read |
---|
| 408 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
| 409 | </DD> |
---|
| 410 | </DL> |
---|
| 411 | <HR> |
---|
| 412 | |
---|
| 413 | <A NAME="writeTo(java.io.DataOutputStream)"><!-- --></A><H3> |
---|
| 414 | writeTo</H3> |
---|
| 415 | <PRE> |
---|
| 416 | public void <B>writeTo</B>(java.io.DataOutputStream os) |
---|
| 417 | throws java.io.IOException</PRE> |
---|
| 418 | <DL> |
---|
| 419 | <DD>Public API - writes this Frame to the given DataOutputStream |
---|
| 420 | <P> |
---|
| 421 | <DD><DL> |
---|
| 422 | |
---|
| 423 | <DT><B>Throws:</B> |
---|
| 424 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
| 425 | </DD> |
---|
| 426 | </DL> |
---|
| 427 | <HR> |
---|
| 428 | |
---|
| 429 | <A NAME="getPayload()"><!-- --></A><H3> |
---|
| 430 | getPayload</H3> |
---|
| 431 | <PRE> |
---|
| 432 | public byte[] <B>getPayload</B>()</PRE> |
---|
| 433 | <DL> |
---|
| 434 | <DD>Public API - retrieves the frame payload |
---|
| 435 | <P> |
---|
| 436 | <DD><DL> |
---|
| 437 | </DL> |
---|
| 438 | </DD> |
---|
| 439 | </DL> |
---|
| 440 | <HR> |
---|
| 441 | |
---|
| 442 | <A NAME="getInputStream()"><!-- --></A><H3> |
---|
| 443 | getInputStream</H3> |
---|
| 444 | <PRE> |
---|
| 445 | public java.io.DataInputStream <B>getInputStream</B>()</PRE> |
---|
| 446 | <DL> |
---|
| 447 | <DD>Public API - retrieves a new DataInputStream streaming over the payload |
---|
| 448 | <P> |
---|
| 449 | <DD><DL> |
---|
| 450 | </DL> |
---|
| 451 | </DD> |
---|
| 452 | </DL> |
---|
| 453 | <HR> |
---|
| 454 | |
---|
| 455 | <A NAME="getOutputStream()"><!-- --></A><H3> |
---|
| 456 | getOutputStream</H3> |
---|
| 457 | <PRE> |
---|
| 458 | public java.io.DataOutputStream <B>getOutputStream</B>()</PRE> |
---|
| 459 | <DL> |
---|
| 460 | <DD>Public API - retrieves a fresh DataOutputStream streaming into the accumulator |
---|
| 461 | <P> |
---|
| 462 | <DD><DL> |
---|
| 463 | </DL> |
---|
| 464 | </DD> |
---|
| 465 | </DL> |
---|
| 466 | <HR> |
---|
| 467 | |
---|
| 468 | <A NAME="toString()"><!-- --></A><H3> |
---|
| 469 | toString</H3> |
---|
| 470 | <PRE> |
---|
| 471 | public java.lang.String <B>toString</B>()</PRE> |
---|
| 472 | <DL> |
---|
| 473 | <DD><DL> |
---|
| 474 | <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> |
---|
| 475 | </DD> |
---|
| 476 | <DD><DL> |
---|
| 477 | </DL> |
---|
| 478 | </DD> |
---|
| 479 | </DL> |
---|
| 480 | <HR> |
---|
| 481 | |
---|
| 482 | <A NAME="tableSize(java.util.Map)"><!-- --></A><H3> |
---|
| 483 | tableSize</H3> |
---|
| 484 | <PRE> |
---|
| 485 | public static long <B>tableSize</B>(java.util.Map<java.lang.String,java.lang.Object> table) |
---|
| 486 | throws java.io.UnsupportedEncodingException</PRE> |
---|
| 487 | <DL> |
---|
| 488 | <DD>Computes the AMQP wire-protocol length of protocol-encoded table entries. |
---|
| 489 | <P> |
---|
| 490 | <DD><DL> |
---|
| 491 | |
---|
| 492 | <DT><B>Throws:</B> |
---|
| 493 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL> |
---|
| 494 | </DD> |
---|
| 495 | </DL> |
---|
| 496 | <HR> |
---|
| 497 | |
---|
| 498 | <A NAME="arraySize(java.util.List)"><!-- --></A><H3> |
---|
| 499 | arraySize</H3> |
---|
| 500 | <PRE> |
---|
| 501 | public static long <B>arraySize</B>(java.util.List<?> values) |
---|
| 502 | throws java.io.UnsupportedEncodingException</PRE> |
---|
| 503 | <DL> |
---|
| 504 | <DD>Computes the AMQP wire-protocol length of an encoded field-array of type List<?> |
---|
| 505 | <P> |
---|
| 506 | <DD><DL> |
---|
| 507 | |
---|
| 508 | <DT><B>Throws:</B> |
---|
| 509 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL> |
---|
| 510 | </DD> |
---|
| 511 | </DL> |
---|
| 512 | <HR> |
---|
| 513 | |
---|
| 514 | <A NAME="arraySize(java.lang.Object[])"><!-- --></A><H3> |
---|
| 515 | arraySize</H3> |
---|
| 516 | <PRE> |
---|
| 517 | public static long <B>arraySize</B>(java.lang.Object[] values) |
---|
| 518 | throws java.io.UnsupportedEncodingException</PRE> |
---|
| 519 | <DL> |
---|
| 520 | <DD>Computes the AMQP wire-protocol length of an encoded field-array of type Object[] |
---|
| 521 | <P> |
---|
| 522 | <DD><DL> |
---|
| 523 | |
---|
| 524 | <DT><B>Throws:</B> |
---|
| 525 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL> |
---|
| 526 | </DD> |
---|
| 527 | </DL> |
---|
| 528 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 529 | <HR> |
---|
| 530 | |
---|
| 531 | |
---|
| 532 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
| 533 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 534 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
| 535 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 536 | <TR> |
---|
| 537 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 538 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 539 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 540 | <TR ALIGN="center" VALIGN="top"> |
---|
| 541 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 542 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 543 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 544 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 545 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 546 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
| 547 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 548 | </TR> |
---|
| 549 | </TABLE> |
---|
| 550 | </TD> |
---|
| 551 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 552 | </EM> |
---|
| 553 | </TD> |
---|
| 554 | </TR> |
---|
| 555 | |
---|
| 556 | <TR> |
---|
| 557 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 558 | <A HREF="../../../../com/rabbitmq/client/impl/ExternalMechanism.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A> |
---|
| 559 | <A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 560 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 561 | <A HREF="../../../../index.html?com/rabbitmq/client/impl/Frame.html" target="_top"><B>FRAMES</B></A> |
---|
| 562 | <A HREF="Frame.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 563 | <SCRIPT type="text/javascript"> |
---|
| 564 | <!-- |
---|
| 565 | if(window==top) { |
---|
| 566 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 567 | } |
---|
| 568 | //--> |
---|
| 569 | </SCRIPT> |
---|
| 570 | <NOSCRIPT> |
---|
| 571 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 572 | </NOSCRIPT> |
---|
| 573 | |
---|
| 574 | |
---|
| 575 | </FONT></TD> |
---|
| 576 | </TR> |
---|
| 577 | <TR> |
---|
| 578 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 579 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 580 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 581 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 582 | </TR> |
---|
| 583 | </TABLE> |
---|
| 584 | <A NAME="skip-navbar_bottom"></A> |
---|
| 585 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
| 586 | |
---|
| 587 | <HR> |
---|
| 588 | |
---|
| 589 | </BODY> |
---|
| 590 | </HTML> |
---|