[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 | SocketFrameHandler |
---|
| 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="SocketFrameHandler"; |
---|
| 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/ShutdownNotifierComponent.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A> |
---|
| 58 | <A HREF="../../../../com/rabbitmq/client/impl/TruncatedInputStream.html" title="class 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/SocketFrameHandler.html" target="_top"><B>FRAMES</B></A> |
---|
| 61 | <A HREF="SocketFrameHandler.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 SocketFrameHandler</H2> |
---|
| 93 | <PRE> |
---|
| 94 | java.lang.Object |
---|
| 95 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.impl.SocketFrameHandler</B> |
---|
| 96 | </PRE> |
---|
| 97 | <DL> |
---|
| 98 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></DD> |
---|
| 99 | </DL> |
---|
| 100 | <HR> |
---|
| 101 | <DL> |
---|
| 102 | <DT><PRE>public class <B>SocketFrameHandler</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></DL> |
---|
| 103 | </PRE> |
---|
| 104 | |
---|
| 105 | <P> |
---|
| 106 | A socket-based frame handler. |
---|
| 107 | <P> |
---|
| 108 | |
---|
| 109 | <P> |
---|
| 110 | <HR> |
---|
| 111 | |
---|
| 112 | <P> |
---|
| 113 | <!-- =========== FIELD SUMMARY =========== --> |
---|
| 114 | |
---|
| 115 | <A NAME="field_summary"><!-- --></A> |
---|
| 116 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 117 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 118 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 119 | <B>Field Summary</B></FONT></TH> |
---|
| 120 | </TR> |
---|
| 121 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 122 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 123 | <CODE>static int</CODE></FONT></TD> |
---|
| 124 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#SOCKET_CLOSING_TIMEOUT">SOCKET_CLOSING_TIMEOUT</A></B></CODE> |
---|
| 125 | |
---|
| 126 | <BR> |
---|
| 127 | Time to linger before closing the socket forcefully.</TD> |
---|
| 128 | </TR> |
---|
| 129 | </TABLE> |
---|
| 130 | |
---|
| 131 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
| 132 | |
---|
| 133 | <A NAME="constructor_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>Constructor Summary</B></FONT></TH> |
---|
| 138 | </TR> |
---|
| 139 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 140 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#SocketFrameHandler(java.net.Socket)">SocketFrameHandler</A></B>(java.net.Socket socket)</CODE> |
---|
| 141 | |
---|
| 142 | <BR> |
---|
| 143 | </TD> |
---|
| 144 | </TR> |
---|
| 145 | </TABLE> |
---|
| 146 | |
---|
| 147 | <!-- ========== METHOD SUMMARY =========== --> |
---|
| 148 | |
---|
| 149 | <A NAME="method_summary"><!-- --></A> |
---|
| 150 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 151 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 152 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
| 153 | <B>Method Summary</B></FONT></TH> |
---|
| 154 | </TR> |
---|
| 155 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 156 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 157 | <CODE> void</CODE></FONT></TD> |
---|
| 158 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#close()">close</A></B>()</CODE> |
---|
| 159 | |
---|
| 160 | <BR> |
---|
| 161 | Close the underlying data connection (complaint not permitted).</TD> |
---|
| 162 | </TR> |
---|
| 163 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 164 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 165 | <CODE> void</CODE></FONT></TD> |
---|
| 166 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#flush()">flush</A></B>()</CODE> |
---|
| 167 | |
---|
| 168 | <BR> |
---|
| 169 | Flush the underlying data connection.</TD> |
---|
| 170 | </TR> |
---|
| 171 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 172 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 173 | <CODE> java.net.InetAddress</CODE></FONT></TD> |
---|
| 174 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#getAddress()">getAddress</A></B>()</CODE> |
---|
| 175 | |
---|
| 176 | <BR> |
---|
| 177 | Retrieve address of peer.</TD> |
---|
| 178 | </TR> |
---|
| 179 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 180 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 181 | <CODE> java.io.DataInputStream</CODE></FONT></TD> |
---|
| 182 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#getInputStream()">getInputStream</A></B>()</CODE> |
---|
| 183 | |
---|
| 184 | <BR> |
---|
| 185 | </TD> |
---|
| 186 | </TR> |
---|
| 187 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 188 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 189 | <CODE> int</CODE></FONT></TD> |
---|
| 190 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#getPort()">getPort</A></B>()</CODE> |
---|
| 191 | |
---|
| 192 | <BR> |
---|
| 193 | Retrieve port number of peer.</TD> |
---|
| 194 | </TR> |
---|
| 195 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 196 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 197 | <CODE> int</CODE></FONT></TD> |
---|
| 198 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#getTimeout()">getTimeout</A></B>()</CODE> |
---|
| 199 | |
---|
| 200 | <BR> |
---|
| 201 | Get the underlying socket's read timeout in milliseconds.</TD> |
---|
| 202 | </TR> |
---|
| 203 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 204 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 205 | <CODE> <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A></CODE></FONT></TD> |
---|
| 206 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#readFrame()">readFrame</A></B>()</CODE> |
---|
| 207 | |
---|
| 208 | <BR> |
---|
| 209 | Read a <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl"><CODE>Frame</CODE></A> from the underlying data connection.</TD> |
---|
| 210 | </TR> |
---|
| 211 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 212 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 213 | <CODE> void</CODE></FONT></TD> |
---|
| 214 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#sendHeader()">sendHeader</A></B>()</CODE> |
---|
| 215 | |
---|
| 216 | <BR> |
---|
| 217 | Send the initial connection header, thus kickstarting the AMQP |
---|
| 218 | protocol version negotiation process and putting the underlying |
---|
| 219 | connection in a state such that the next layer of startup can |
---|
| 220 | proceed.</TD> |
---|
| 221 | </TR> |
---|
| 222 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 223 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 224 | <CODE> void</CODE></FONT></TD> |
---|
| 225 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#sendHeader(int, int)">sendHeader</A></B>(int major, |
---|
| 226 | int minor)</CODE> |
---|
| 227 | |
---|
| 228 | <BR> |
---|
| 229 | Write a 0-8-style connection header to the underlying socket, |
---|
| 230 | containing the specified version information, kickstarting the |
---|
| 231 | AMQP protocol version negotiation process.</TD> |
---|
| 232 | </TR> |
---|
| 233 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 234 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 235 | <CODE> void</CODE></FONT></TD> |
---|
| 236 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#sendHeader(int, int, int)">sendHeader</A></B>(int major, |
---|
| 237 | int minor, |
---|
| 238 | int revision)</CODE> |
---|
| 239 | |
---|
| 240 | <BR> |
---|
| 241 | Write a 0-9-1-style connection header to the underlying socket, |
---|
| 242 | containing the specified version information, kickstarting the |
---|
| 243 | AMQP protocol version negotiation process.</TD> |
---|
| 244 | </TR> |
---|
| 245 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 246 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 247 | <CODE> void</CODE></FONT></TD> |
---|
| 248 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#setTimeout(int)">setTimeout</A></B>(int timeoutMs)</CODE> |
---|
| 249 | |
---|
| 250 | <BR> |
---|
| 251 | Set the underlying socket's read timeout in milliseconds, if applicable.</TD> |
---|
| 252 | </TR> |
---|
| 253 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 254 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
| 255 | <CODE> void</CODE></FONT></TD> |
---|
| 256 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#writeFrame(com.rabbitmq.client.impl.Frame)">writeFrame</A></B>(<A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A> frame)</CODE> |
---|
| 257 | |
---|
| 258 | <BR> |
---|
| 259 | Write a <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl"><CODE>Frame</CODE></A> to the underlying data connection.</TD> |
---|
| 260 | </TR> |
---|
| 261 | </TABLE> |
---|
| 262 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
| 263 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 264 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
| 265 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
---|
| 266 | </TR> |
---|
| 267 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
| 268 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
---|
| 269 | </TR> |
---|
| 270 | </TABLE> |
---|
| 271 | |
---|
| 272 | <P> |
---|
| 273 | |
---|
| 274 | <!-- ============ FIELD DETAIL =========== --> |
---|
| 275 | |
---|
| 276 | <A NAME="field_detail"><!-- --></A> |
---|
| 277 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 278 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 279 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 280 | <B>Field Detail</B></FONT></TH> |
---|
| 281 | </TR> |
---|
| 282 | </TABLE> |
---|
| 283 | |
---|
| 284 | <A NAME="SOCKET_CLOSING_TIMEOUT"><!-- --></A><H3> |
---|
| 285 | SOCKET_CLOSING_TIMEOUT</H3> |
---|
| 286 | <PRE> |
---|
| 287 | public static final int <B>SOCKET_CLOSING_TIMEOUT</B></PRE> |
---|
| 288 | <DL> |
---|
| 289 | <DD>Time to linger before closing the socket forcefully. |
---|
| 290 | <P> |
---|
| 291 | <DL> |
---|
| 292 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.rabbitmq.client.impl.SocketFrameHandler.SOCKET_CLOSING_TIMEOUT">Constant Field Values</A></DL> |
---|
| 293 | </DL> |
---|
| 294 | |
---|
| 295 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
| 296 | |
---|
| 297 | <A NAME="constructor_detail"><!-- --></A> |
---|
| 298 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 299 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 300 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 301 | <B>Constructor Detail</B></FONT></TH> |
---|
| 302 | </TR> |
---|
| 303 | </TABLE> |
---|
| 304 | |
---|
| 305 | <A NAME="SocketFrameHandler(java.net.Socket)"><!-- --></A><H3> |
---|
| 306 | SocketFrameHandler</H3> |
---|
| 307 | <PRE> |
---|
| 308 | public <B>SocketFrameHandler</B>(java.net.Socket socket) |
---|
| 309 | throws java.io.IOException</PRE> |
---|
| 310 | <DL> |
---|
| 311 | <DL> |
---|
| 312 | <DT><B>Parameters:</B><DD><CODE>socket</CODE> - the socket to use |
---|
| 313 | <DT><B>Throws:</B> |
---|
| 314 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
| 315 | </DL> |
---|
| 316 | |
---|
| 317 | <!-- ============ METHOD DETAIL ========== --> |
---|
| 318 | |
---|
| 319 | <A NAME="method_detail"><!-- --></A> |
---|
| 320 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
| 321 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
| 322 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
| 323 | <B>Method Detail</B></FONT></TH> |
---|
| 324 | </TR> |
---|
| 325 | </TABLE> |
---|
| 326 | |
---|
| 327 | <A NAME="getAddress()"><!-- --></A><H3> |
---|
| 328 | getAddress</H3> |
---|
| 329 | <PRE> |
---|
| 330 | public java.net.InetAddress <B>getAddress</B>()</PRE> |
---|
| 331 | <DL> |
---|
| 332 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#getAddress()">FrameHandler</A></CODE></B></DD> |
---|
| 333 | <DD>Retrieve address of peer. |
---|
| 334 | <P> |
---|
| 335 | <DD><DL> |
---|
| 336 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#getAddress()">getAddress</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></DL> |
---|
| 337 | </DD> |
---|
| 338 | <DD><DL> |
---|
| 339 | </DL> |
---|
| 340 | </DD> |
---|
| 341 | </DL> |
---|
| 342 | <HR> |
---|
| 343 | |
---|
| 344 | <A NAME="getInputStream()"><!-- --></A><H3> |
---|
| 345 | getInputStream</H3> |
---|
| 346 | <PRE> |
---|
| 347 | public java.io.DataInputStream <B>getInputStream</B>()</PRE> |
---|
| 348 | <DL> |
---|
| 349 | <DD><DL> |
---|
| 350 | </DL> |
---|
| 351 | </DD> |
---|
| 352 | <DD><DL> |
---|
| 353 | </DL> |
---|
| 354 | </DD> |
---|
| 355 | </DL> |
---|
| 356 | <HR> |
---|
| 357 | |
---|
| 358 | <A NAME="getPort()"><!-- --></A><H3> |
---|
| 359 | getPort</H3> |
---|
| 360 | <PRE> |
---|
| 361 | public int <B>getPort</B>()</PRE> |
---|
| 362 | <DL> |
---|
| 363 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#getPort()">FrameHandler</A></CODE></B></DD> |
---|
| 364 | <DD>Retrieve port number of peer. |
---|
| 365 | <P> |
---|
| 366 | <DD><DL> |
---|
| 367 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#getPort()">getPort</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></DL> |
---|
| 368 | </DD> |
---|
| 369 | <DD><DL> |
---|
| 370 | </DL> |
---|
| 371 | </DD> |
---|
| 372 | </DL> |
---|
| 373 | <HR> |
---|
| 374 | |
---|
| 375 | <A NAME="setTimeout(int)"><!-- --></A><H3> |
---|
| 376 | setTimeout</H3> |
---|
| 377 | <PRE> |
---|
| 378 | public void <B>setTimeout</B>(int timeoutMs) |
---|
| 379 | throws java.net.SocketException</PRE> |
---|
| 380 | <DL> |
---|
| 381 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#setTimeout(int)">FrameHandler</A></CODE></B></DD> |
---|
| 382 | <DD>Set the underlying socket's read timeout in milliseconds, if applicable. |
---|
| 383 | <P> |
---|
| 384 | <DD><DL> |
---|
| 385 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#setTimeout(int)">setTimeout</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></DL> |
---|
| 386 | </DD> |
---|
| 387 | <DD><DL> |
---|
| 388 | <DT><B>Parameters:</B><DD><CODE>timeoutMs</CODE> - The timeout in milliseconds |
---|
| 389 | <DT><B>Throws:</B> |
---|
| 390 | <DD><CODE>java.net.SocketException</CODE></DL> |
---|
| 391 | </DD> |
---|
| 392 | </DL> |
---|
| 393 | <HR> |
---|
| 394 | |
---|
| 395 | <A NAME="getTimeout()"><!-- --></A><H3> |
---|
| 396 | getTimeout</H3> |
---|
| 397 | <PRE> |
---|
| 398 | public int <B>getTimeout</B>() |
---|
| 399 | throws java.net.SocketException</PRE> |
---|
| 400 | <DL> |
---|
| 401 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#getTimeout()">FrameHandler</A></CODE></B></DD> |
---|
| 402 | <DD>Get the underlying socket's read timeout in milliseconds. |
---|
| 403 | <P> |
---|
| 404 | <DD><DL> |
---|
| 405 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#getTimeout()">getTimeout</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></DL> |
---|
| 406 | </DD> |
---|
| 407 | <DD><DL> |
---|
| 408 | |
---|
| 409 | <DT><B>Returns:</B><DD>The timeout in milliseconds |
---|
| 410 | <DT><B>Throws:</B> |
---|
| 411 | <DD><CODE>java.net.SocketException</CODE></DL> |
---|
| 412 | </DD> |
---|
| 413 | </DL> |
---|
| 414 | <HR> |
---|
| 415 | |
---|
| 416 | <A NAME="sendHeader(int, int)"><!-- --></A><H3> |
---|
| 417 | sendHeader</H3> |
---|
| 418 | <PRE> |
---|
| 419 | public void <B>sendHeader</B>(int major, |
---|
| 420 | int minor) |
---|
| 421 | throws java.io.IOException</PRE> |
---|
| 422 | <DL> |
---|
| 423 | <DD>Write a 0-8-style connection header to the underlying socket, |
---|
| 424 | containing the specified version information, kickstarting the |
---|
| 425 | AMQP protocol version negotiation process. |
---|
| 426 | <P> |
---|
| 427 | <DD><DL> |
---|
| 428 | </DL> |
---|
| 429 | </DD> |
---|
| 430 | <DD><DL> |
---|
| 431 | <DT><B>Parameters:</B><DD><CODE>major</CODE> - major protocol version number<DD><CODE>minor</CODE> - minor protocol version number |
---|
| 432 | <DT><B>Throws:</B> |
---|
| 433 | <DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection<DT><B>See Also:</B><DD><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#sendHeader()"><CODE>sendHeader()</CODE></A></DL> |
---|
| 434 | </DD> |
---|
| 435 | </DL> |
---|
| 436 | <HR> |
---|
| 437 | |
---|
| 438 | <A NAME="sendHeader(int, int, int)"><!-- --></A><H3> |
---|
| 439 | sendHeader</H3> |
---|
| 440 | <PRE> |
---|
| 441 | public void <B>sendHeader</B>(int major, |
---|
| 442 | int minor, |
---|
| 443 | int revision) |
---|
| 444 | throws java.io.IOException</PRE> |
---|
| 445 | <DL> |
---|
| 446 | <DD>Write a 0-9-1-style connection header to the underlying socket, |
---|
| 447 | containing the specified version information, kickstarting the |
---|
| 448 | AMQP protocol version negotiation process. |
---|
| 449 | <P> |
---|
| 450 | <DD><DL> |
---|
| 451 | </DL> |
---|
| 452 | </DD> |
---|
| 453 | <DD><DL> |
---|
| 454 | <DT><B>Parameters:</B><DD><CODE>major</CODE> - major protocol version number<DD><CODE>minor</CODE> - minor protocol version number<DD><CODE>revision</CODE> - protocol revision number |
---|
| 455 | <DT><B>Throws:</B> |
---|
| 456 | <DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection<DT><B>See Also:</B><DD><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html#sendHeader()"><CODE>sendHeader()</CODE></A></DL> |
---|
| 457 | </DD> |
---|
| 458 | </DL> |
---|
| 459 | <HR> |
---|
| 460 | |
---|
| 461 | <A NAME="sendHeader()"><!-- --></A><H3> |
---|
| 462 | sendHeader</H3> |
---|
| 463 | <PRE> |
---|
| 464 | public void <B>sendHeader</B>() |
---|
| 465 | throws java.io.IOException</PRE> |
---|
| 466 | <DL> |
---|
| 467 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#sendHeader()">FrameHandler</A></CODE></B></DD> |
---|
| 468 | <DD>Send the initial connection header, thus kickstarting the AMQP |
---|
| 469 | protocol version negotiation process and putting the underlying |
---|
| 470 | connection in a state such that the next layer of startup can |
---|
| 471 | proceed. |
---|
| 472 | <P> |
---|
| 473 | <DD><DL> |
---|
| 474 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#sendHeader()">sendHeader</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></DL> |
---|
| 475 | </DD> |
---|
| 476 | <DD><DL> |
---|
| 477 | |
---|
| 478 | <DT><B>Throws:</B> |
---|
| 479 | <DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection</DL> |
---|
| 480 | </DD> |
---|
| 481 | </DL> |
---|
| 482 | <HR> |
---|
| 483 | |
---|
| 484 | <A NAME="readFrame()"><!-- --></A><H3> |
---|
| 485 | readFrame</H3> |
---|
| 486 | <PRE> |
---|
| 487 | public <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A> <B>readFrame</B>() |
---|
| 488 | throws java.io.IOException</PRE> |
---|
| 489 | <DL> |
---|
| 490 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#readFrame()">FrameHandler</A></CODE></B></DD> |
---|
| 491 | <DD>Read a <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl"><CODE>Frame</CODE></A> from the underlying data connection. |
---|
| 492 | <P> |
---|
| 493 | <DD><DL> |
---|
| 494 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#readFrame()">readFrame</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></DL> |
---|
| 495 | </DD> |
---|
| 496 | <DD><DL> |
---|
| 497 | |
---|
| 498 | <DT><B>Returns:</B><DD>an incoming Frame, or null if there is none |
---|
| 499 | <DT><B>Throws:</B> |
---|
| 500 | <DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection |
---|
| 501 | <DD><CODE>java.net.SocketTimeoutException</CODE> - if the underlying read times out</DL> |
---|
| 502 | </DD> |
---|
| 503 | </DL> |
---|
| 504 | <HR> |
---|
| 505 | |
---|
| 506 | <A NAME="writeFrame(com.rabbitmq.client.impl.Frame)"><!-- --></A><H3> |
---|
| 507 | writeFrame</H3> |
---|
| 508 | <PRE> |
---|
| 509 | public void <B>writeFrame</B>(<A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A> frame) |
---|
| 510 | throws java.io.IOException</PRE> |
---|
| 511 | <DL> |
---|
| 512 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#writeFrame(com.rabbitmq.client.impl.Frame)">FrameHandler</A></CODE></B></DD> |
---|
| 513 | <DD>Write a <A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl"><CODE>Frame</CODE></A> to the underlying data connection. |
---|
| 514 | <P> |
---|
| 515 | <DD><DL> |
---|
| 516 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#writeFrame(com.rabbitmq.client.impl.Frame)">writeFrame</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></DL> |
---|
| 517 | </DD> |
---|
| 518 | <DD><DL> |
---|
| 519 | <DT><B>Parameters:</B><DD><CODE>frame</CODE> - the Frame to transmit |
---|
| 520 | <DT><B>Throws:</B> |
---|
| 521 | <DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection</DL> |
---|
| 522 | </DD> |
---|
| 523 | </DL> |
---|
| 524 | <HR> |
---|
| 525 | |
---|
| 526 | <A NAME="flush()"><!-- --></A><H3> |
---|
| 527 | flush</H3> |
---|
| 528 | <PRE> |
---|
| 529 | public void <B>flush</B>() |
---|
| 530 | throws java.io.IOException</PRE> |
---|
| 531 | <DL> |
---|
| 532 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#flush()">FrameHandler</A></CODE></B></DD> |
---|
| 533 | <DD>Flush the underlying data connection. |
---|
| 534 | <P> |
---|
| 535 | <DD><DL> |
---|
| 536 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#flush()">flush</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></DL> |
---|
| 537 | </DD> |
---|
| 538 | <DD><DL> |
---|
| 539 | |
---|
| 540 | <DT><B>Throws:</B> |
---|
| 541 | <DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection</DL> |
---|
| 542 | </DD> |
---|
| 543 | </DL> |
---|
| 544 | <HR> |
---|
| 545 | |
---|
| 546 | <A NAME="close()"><!-- --></A><H3> |
---|
| 547 | close</H3> |
---|
| 548 | <PRE> |
---|
| 549 | public void <B>close</B>()</PRE> |
---|
| 550 | <DL> |
---|
| 551 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#close()">FrameHandler</A></CODE></B></DD> |
---|
| 552 | <DD>Close the underlying data connection (complaint not permitted). |
---|
| 553 | <P> |
---|
| 554 | <DD><DL> |
---|
| 555 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></DL> |
---|
| 556 | </DD> |
---|
| 557 | <DD><DL> |
---|
| 558 | </DL> |
---|
| 559 | </DD> |
---|
| 560 | </DL> |
---|
| 561 | <!-- ========= END OF CLASS DATA ========= --> |
---|
| 562 | <HR> |
---|
| 563 | |
---|
| 564 | |
---|
| 565 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
| 566 | <A NAME="navbar_bottom"><!-- --></A> |
---|
| 567 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
| 568 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
| 569 | <TR> |
---|
| 570 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
| 571 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
| 572 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
| 573 | <TR ALIGN="center" VALIGN="top"> |
---|
| 574 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
| 575 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
| 576 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
| 577 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
| 578 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
| 579 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
| 580 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
| 581 | </TR> |
---|
| 582 | </TABLE> |
---|
| 583 | </TD> |
---|
| 584 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
| 585 | </EM> |
---|
| 586 | </TD> |
---|
| 587 | </TR> |
---|
| 588 | |
---|
| 589 | <TR> |
---|
| 590 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 591 | <A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A> |
---|
| 592 | <A HREF="../../../../com/rabbitmq/client/impl/TruncatedInputStream.html" title="class in com.rabbitmq.client.impl"><B>NEXT CLASS</B></A></FONT></TD> |
---|
| 593 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
| 594 | <A HREF="../../../../index.html?com/rabbitmq/client/impl/SocketFrameHandler.html" target="_top"><B>FRAMES</B></A> |
---|
| 595 | <A HREF="SocketFrameHandler.html" target="_top"><B>NO FRAMES</B></A> |
---|
| 596 | <SCRIPT type="text/javascript"> |
---|
| 597 | <!-- |
---|
| 598 | if(window==top) { |
---|
| 599 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
| 600 | } |
---|
| 601 | //--> |
---|
| 602 | </SCRIPT> |
---|
| 603 | <NOSCRIPT> |
---|
| 604 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
| 605 | </NOSCRIPT> |
---|
| 606 | |
---|
| 607 | |
---|
| 608 | </FONT></TD> |
---|
| 609 | </TR> |
---|
| 610 | <TR> |
---|
| 611 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 612 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
| 613 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
| 614 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
| 615 | </TR> |
---|
| 616 | </TABLE> |
---|
| 617 | <A NAME="skip-navbar_bottom"></A> |
---|
| 618 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
| 619 | |
---|
| 620 | <HR> |
---|
| 621 | |
---|
| 622 | </BODY> |
---|
| 623 | </HTML> |
---|