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

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

new release version
File size: 14.8 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:11 GMT 2012 -->
6<TITLE>
7FrameHandler
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="FrameHandler";
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/impl/Frame.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/LongStringHelper.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/FrameHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="FrameHandler.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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.impl</FONT>
91<BR>
92Interface FrameHandler</H2>
93<DL>
94<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html" title="class in com.rabbitmq.client.impl">SocketFrameHandler</A></DD>
95</DL>
96<HR>
97<DL>
98<DT><PRE>public interface <B>FrameHandler</B></DL>
99</PRE>
100
101<P>
102Interface to a frame handler.
103 <p/>
104 <b>Concurrency</b><br/>
105 Implementations must be thread-safe, and not allow frames to be interleaved, either while reading or writing.
106<P>
107
108<P>
109<HR>
110
111<P>
112
113<!-- ========== METHOD SUMMARY =========== -->
114
115<A NAME="method_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>Method 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>&nbsp;void</CODE></FONT></TD>
124<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#close()">close</A></B>()</CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the underlying data connection (complaint not permitted).</TD>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131<CODE>&nbsp;void</CODE></FONT></TD>
132<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#flush()">flush</A></B>()</CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Flush the underlying data connection.</TD>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>&nbsp;java.net.InetAddress</CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#getAddress()">getAddress</A></B>()</CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve address of peer.</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;int</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#getPort()">getPort</A></B>()</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve port number of peer.</TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155<CODE>&nbsp;int</CODE></FONT></TD>
156<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#getTimeout()">getTimeout</A></B>()</CODE>
157
158<BR>
159&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the underlying socket's read timeout in milliseconds.</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A></CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#readFrame()">readFrame</A></B>()</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#sendHeader()">sendHeader</A></B>()</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send the initial connection header, thus kickstarting the AMQP
176 protocol version negotiation process and putting the underlying
177 connection in a state such that the next layer of startup can
178 proceed.</TD>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182<CODE>&nbsp;void</CODE></FONT></TD>
183<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html#setTimeout(int)">setTimeout</A></B>(int&nbsp;timeoutMs)</CODE>
184
185<BR>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the underlying socket's read timeout in milliseconds, if applicable.</TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<CODE>&nbsp;void</CODE></FONT></TD>
191<TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.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>&nbsp;frame)</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>
195</TR>
196</TABLE>
197&nbsp;
198<P>
199
200<!-- ============ METHOD DETAIL ========== -->
201
202<A NAME="method_detail"><!-- --></A>
203<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
204<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
205<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
206<B>Method Detail</B></FONT></TH>
207</TR>
208</TABLE>
209
210<A NAME="getAddress()"><!-- --></A><H3>
211getAddress</H3>
212<PRE>
213java.net.InetAddress <B>getAddress</B>()</PRE>
214<DL>
215<DD>Retrieve address of peer.
216<P>
217<DD><DL>
218</DL>
219</DD>
220</DL>
221<HR>
222
223<A NAME="getPort()"><!-- --></A><H3>
224getPort</H3>
225<PRE>
226int <B>getPort</B>()</PRE>
227<DL>
228<DD>Retrieve port number of peer.
229<P>
230<DD><DL>
231</DL>
232</DD>
233</DL>
234<HR>
235
236<A NAME="setTimeout(int)"><!-- --></A><H3>
237setTimeout</H3>
238<PRE>
239void <B>setTimeout</B>(int&nbsp;timeoutMs)
240                throws java.net.SocketException</PRE>
241<DL>
242<DD>Set the underlying socket's read timeout in milliseconds, if applicable.
243<P>
244<DD><DL>
245<DT><B>Parameters:</B><DD><CODE>timeoutMs</CODE> - The timeout in milliseconds
246<DT><B>Throws:</B>
247<DD><CODE>java.net.SocketException</CODE></DL>
248</DD>
249</DL>
250<HR>
251
252<A NAME="getTimeout()"><!-- --></A><H3>
253getTimeout</H3>
254<PRE>
255int <B>getTimeout</B>()
256               throws java.net.SocketException</PRE>
257<DL>
258<DD>Get the underlying socket's read timeout in milliseconds.
259<P>
260<DD><DL>
261
262<DT><B>Returns:</B><DD>The timeout in milliseconds
263<DT><B>Throws:</B>
264<DD><CODE>java.net.SocketException</CODE></DL>
265</DD>
266</DL>
267<HR>
268
269<A NAME="sendHeader()"><!-- --></A><H3>
270sendHeader</H3>
271<PRE>
272void <B>sendHeader</B>()
273                throws java.io.IOException</PRE>
274<DL>
275<DD>Send the initial connection header, thus kickstarting the AMQP
276 protocol version negotiation process and putting the underlying
277 connection in a state such that the next layer of startup can
278 proceed.
279<P>
280<DD><DL>
281
282<DT><B>Throws:</B>
283<DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection</DL>
284</DD>
285</DL>
286<HR>
287
288<A NAME="readFrame()"><!-- --></A><H3>
289readFrame</H3>
290<PRE>
291<A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A> <B>readFrame</B>()
292                throws java.io.IOException</PRE>
293<DL>
294<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.
295<P>
296<DD><DL>
297
298<DT><B>Returns:</B><DD>an incoming Frame, or null if there is none
299<DT><B>Throws:</B>
300<DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection
301<DD><CODE>java.net.SocketTimeoutException</CODE> - if the underlying read times out</DL>
302</DD>
303</DL>
304<HR>
305
306<A NAME="writeFrame(com.rabbitmq.client.impl.Frame)"><!-- --></A><H3>
307writeFrame</H3>
308<PRE>
309void <B>writeFrame</B>(<A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A>&nbsp;frame)
310                throws java.io.IOException</PRE>
311<DL>
312<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.
313<P>
314<DD><DL>
315<DT><B>Parameters:</B><DD><CODE>frame</CODE> - the Frame to transmit
316<DT><B>Throws:</B>
317<DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection</DL>
318</DD>
319</DL>
320<HR>
321
322<A NAME="flush()"><!-- --></A><H3>
323flush</H3>
324<PRE>
325void <B>flush</B>()
326           throws java.io.IOException</PRE>
327<DL>
328<DD>Flush the underlying data connection.
329<P>
330<DD><DL>
331
332<DT><B>Throws:</B>
333<DD><CODE>java.io.IOException</CODE> - if there is a problem accessing the connection</DL>
334</DD>
335</DL>
336<HR>
337
338<A NAME="close()"><!-- --></A><H3>
339close</H3>
340<PRE>
341void <B>close</B>()</PRE>
342<DL>
343<DD>Close the underlying data connection (complaint not permitted).
344<P>
345<DD><DL>
346</DL>
347</DD>
348</DL>
349<!-- ========= END OF CLASS DATA ========= -->
350<HR>
351
352
353<!-- ======= START OF BOTTOM NAVBAR ====== -->
354<A NAME="navbar_bottom"><!-- --></A>
355<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
356<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
357<TR>
358<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
359<A NAME="navbar_bottom_firstrow"><!-- --></A>
360<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
361  <TR ALIGN="center" VALIGN="top">
362  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
363  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
364  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
365  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
366  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
367  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
368  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
369  </TR>
370</TABLE>
371</TD>
372<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
373</EM>
374</TD>
375</TR>
376
377<TR>
378<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
379&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A>&nbsp;
380&nbsp;<A HREF="../../../../com/rabbitmq/client/impl/LongStringHelper.html" title="class in com.rabbitmq.client.impl"><B>NEXT CLASS</B></A></FONT></TD>
381<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
382  <A HREF="../../../../index.html?com/rabbitmq/client/impl/FrameHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
383&nbsp;<A HREF="FrameHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
384&nbsp;<SCRIPT type="text/javascript">
385  <!--
386  if(window==top) {
387    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
388  }
389  //-->
390</SCRIPT>
391<NOSCRIPT>
392  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
393</NOSCRIPT>
394
395
396</FONT></TD>
397</TR>
398<TR>
399<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
400  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
401<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
402DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
403</TR>
404</TABLE>
405<A NAME="skip-navbar_bottom"></A>
406<!-- ======== END OF BOTTOM NAVBAR ======= -->
407
408<HR>
409
410</BODY>
411</HTML>
Note: See TracBrowser for help on using the repository browser.