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:10 GMT 2012 --> |
---|
6 | <TITLE> |
---|
7 | AMQConnection |
---|
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="AMQConnection"; |
---|
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/AMQCommand.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A> |
---|
58 | <A HREF="../../../../com/rabbitmq/client/impl/AMQContentHeader.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/AMQConnection.html" target="_top"><B>FRAMES</B></A> |
---|
61 | <A HREF="AMQConnection.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 AMQConnection</H2> |
---|
93 | <PRE> |
---|
94 | java.lang.Object |
---|
95 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html" title="class in com.rabbitmq.client.impl">com.rabbitmq.client.impl.ShutdownNotifierComponent</A> |
---|
96 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.impl.AMQConnection</B> |
---|
97 | </PRE> |
---|
98 | <DL> |
---|
99 | <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A>, <A HREF="../../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</A></DD> |
---|
100 | </DL> |
---|
101 | <HR> |
---|
102 | <DL> |
---|
103 | <DT><PRE>public class <B>AMQConnection</B><DT>extends <A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html" title="class in com.rabbitmq.client.impl">ShutdownNotifierComponent</A><DT>implements <A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></DL> |
---|
104 | </PRE> |
---|
105 | |
---|
106 | <P> |
---|
107 | Concrete class representing and managing an AMQP connection to a broker. |
---|
108 | <p> |
---|
109 | To create a broker connection, use <A HREF="../../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client"><CODE>ConnectionFactory</CODE></A>. See <A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client"><CODE>Connection</CODE></A> |
---|
110 | for an example. |
---|
111 | <P> |
---|
112 | |
---|
113 | <P> |
---|
114 | <HR> |
---|
115 | |
---|
116 | <P> |
---|
117 | <!-- =========== FIELD SUMMARY =========== --> |
---|
118 | |
---|
119 | <A NAME="field_summary"><!-- --></A> |
---|
120 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
121 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
122 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
123 | <B>Field Summary</B></FONT></TH> |
---|
124 | </TR> |
---|
125 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
126 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
127 | <CODE>static int</CODE></FONT></TD> |
---|
128 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#HANDSHAKE_TIMEOUT">HANDSHAKE_TIMEOUT</A></B></CODE> |
---|
129 | |
---|
130 | <BR> |
---|
131 | Timeout used while waiting for AMQP handshaking to complete (milliseconds)</TD> |
---|
132 | </TR> |
---|
133 | </TABLE> |
---|
134 | |
---|
135 | <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
---|
136 | |
---|
137 | <A NAME="constructor_summary"><!-- --></A> |
---|
138 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
139 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
140 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
141 | <B>Constructor Summary</B></FONT></TH> |
---|
142 | </TR> |
---|
143 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
144 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#AMQConnection(java.lang.String, java.lang.String, com.rabbitmq.client.impl.FrameHandler, java.util.concurrent.ExecutorService, java.lang.String, java.util.Map, int, int, int, com.rabbitmq.client.SaslConfig)">AMQConnection</A></B>(java.lang.String username, |
---|
145 | java.lang.String password, |
---|
146 | <A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A> frameHandler, |
---|
147 | java.util.concurrent.ExecutorService executor, |
---|
148 | java.lang.String virtualHost, |
---|
149 | java.util.Map<java.lang.String,java.lang.Object> clientProperties, |
---|
150 | int requestedFrameMax, |
---|
151 | int requestedChannelMax, |
---|
152 | int requestedHeartbeat, |
---|
153 | <A HREF="../../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client">SaslConfig</A> saslConfig)</CODE> |
---|
154 | |
---|
155 | <BR> |
---|
156 | Construct a new connection using a default ExeceptionHandler</TD> |
---|
157 | </TR> |
---|
158 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
159 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#AMQConnection(java.lang.String, java.lang.String, com.rabbitmq.client.impl.FrameHandler, java.util.concurrent.ExecutorService, java.lang.String, java.util.Map, int, int, int, com.rabbitmq.client.SaslConfig, com.rabbitmq.client.impl.ExceptionHandler)">AMQConnection</A></B>(java.lang.String username, |
---|
160 | java.lang.String password, |
---|
161 | <A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A> frameHandler, |
---|
162 | java.util.concurrent.ExecutorService executor, |
---|
163 | java.lang.String virtualHost, |
---|
164 | java.util.Map<java.lang.String,java.lang.Object> clientProperties, |
---|
165 | int requestedFrameMax, |
---|
166 | int requestedChannelMax, |
---|
167 | int requestedHeartbeat, |
---|
168 | <A HREF="../../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client">SaslConfig</A> saslConfig, |
---|
169 | <A HREF="../../../../com/rabbitmq/client/impl/ExceptionHandler.html" title="interface in com.rabbitmq.client.impl">ExceptionHandler</A> execeptionHandler)</CODE> |
---|
170 | |
---|
171 | <BR> |
---|
172 | Construct a new connection</TD> |
---|
173 | </TR> |
---|
174 | </TABLE> |
---|
175 | |
---|
176 | <!-- ========== METHOD SUMMARY =========== --> |
---|
177 | |
---|
178 | <A NAME="method_summary"><!-- --></A> |
---|
179 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
180 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
181 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
182 | <B>Method Summary</B></FONT></TH> |
---|
183 | </TR> |
---|
184 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
185 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
186 | <CODE> void</CODE></FONT></TD> |
---|
187 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#abort()">abort</A></B>()</CODE> |
---|
188 | |
---|
189 | <BR> |
---|
190 | Public API - Abort this connection and all its channels |
---|
191 | with the <A HREF="../../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code |
---|
192 | and message 'OK'.</TD> |
---|
193 | </TR> |
---|
194 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
195 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
196 | <CODE> void</CODE></FONT></TD> |
---|
197 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#abort(int)">abort</A></B>(int timeout)</CODE> |
---|
198 | |
---|
199 | <BR> |
---|
200 | Public API - Abort this connection and all its channels |
---|
201 | with the <A HREF="../../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code |
---|
202 | and message 'OK'.</TD> |
---|
203 | </TR> |
---|
204 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
205 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
206 | <CODE> void</CODE></FONT></TD> |
---|
207 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#abort(int, java.lang.String)">abort</A></B>(int closeCode, |
---|
208 | java.lang.String closeMessage)</CODE> |
---|
209 | |
---|
210 | <BR> |
---|
211 | Public API - Abort this connection and all its channels.</TD> |
---|
212 | </TR> |
---|
213 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
214 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
215 | <CODE> void</CODE></FONT></TD> |
---|
216 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#abort(int, java.lang.String, int)">abort</A></B>(int closeCode, |
---|
217 | java.lang.String closeMessage, |
---|
218 | int timeout)</CODE> |
---|
219 | |
---|
220 | <BR> |
---|
221 | Public API - Abort this connection and all its channels.</TD> |
---|
222 | </TR> |
---|
223 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
224 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
225 | <CODE> void</CODE></FONT></TD> |
---|
226 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#close()">close</A></B>()</CODE> |
---|
227 | |
---|
228 | <BR> |
---|
229 | Public API - Close this connection and all its channels |
---|
230 | with the <A HREF="../../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code |
---|
231 | and message 'OK'.</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/AMQConnection.html#close(int)">close</A></B>(int timeout)</CODE> |
---|
237 | |
---|
238 | <BR> |
---|
239 | Public API - Close this connection and all its channels |
---|
240 | with the <A HREF="../../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code |
---|
241 | and message 'OK'.</TD> |
---|
242 | </TR> |
---|
243 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
244 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
245 | <CODE> void</CODE></FONT></TD> |
---|
246 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#close(int, java.lang.String)">close</A></B>(int closeCode, |
---|
247 | java.lang.String closeMessage)</CODE> |
---|
248 | |
---|
249 | <BR> |
---|
250 | Public API - Close this connection and all its channels.</TD> |
---|
251 | </TR> |
---|
252 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
253 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
254 | <CODE> void</CODE></FONT></TD> |
---|
255 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#close(int, java.lang.String, boolean, java.lang.Throwable)">close</A></B>(int closeCode, |
---|
256 | java.lang.String closeMessage, |
---|
257 | boolean initiatedByApplication, |
---|
258 | java.lang.Throwable cause)</CODE> |
---|
259 | |
---|
260 | <BR> |
---|
261 | Protected API - Delegates to <A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#close(int, java.lang.String, boolean, java.lang.Throwable, int, boolean)"><CODE>the |
---|
262 | six-argument close method</CODE></A>, passing -1 for the timeout, and |
---|
263 | false for the abort flag.</TD> |
---|
264 | </TR> |
---|
265 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
266 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
267 | <CODE> void</CODE></FONT></TD> |
---|
268 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#close(int, java.lang.String, boolean, java.lang.Throwable, int, boolean)">close</A></B>(int closeCode, |
---|
269 | java.lang.String closeMessage, |
---|
270 | boolean initiatedByApplication, |
---|
271 | java.lang.Throwable cause, |
---|
272 | int timeout, |
---|
273 | boolean abort)</CODE> |
---|
274 | |
---|
275 | <BR> |
---|
276 | Protected API - Close this connection with the given code, message, source |
---|
277 | and timeout value for all the close operations to complete.</TD> |
---|
278 | </TR> |
---|
279 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
280 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
281 | <CODE> void</CODE></FONT></TD> |
---|
282 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#close(int, java.lang.String, int)">close</A></B>(int closeCode, |
---|
283 | java.lang.String closeMessage, |
---|
284 | int timeout)</CODE> |
---|
285 | |
---|
286 | <BR> |
---|
287 | Public API - Close this connection and all its channels.</TD> |
---|
288 | </TR> |
---|
289 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
290 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
291 | <CODE> <A HREF="../../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A></CODE></FONT></TD> |
---|
292 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#createChannel()">createChannel</A></B>()</CODE> |
---|
293 | |
---|
294 | <BR> |
---|
295 | Public API - Create a new channel, using an internally allocated channel number.</TD> |
---|
296 | </TR> |
---|
297 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
298 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
299 | <CODE> <A HREF="../../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A></CODE></FONT></TD> |
---|
300 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#createChannel(int)">createChannel</A></B>(int channelNumber)</CODE> |
---|
301 | |
---|
302 | <BR> |
---|
303 | Public API - Create a new channel, using the specified channel number if possible.</TD> |
---|
304 | </TR> |
---|
305 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
306 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
307 | <CODE>static java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> |
---|
308 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#defaultClientProperties()">defaultClientProperties</A></B>()</CODE> |
---|
309 | |
---|
310 | <BR> |
---|
311 | Retrieve a copy of the default table of client properties that |
---|
312 | will be sent to the server during connection startup.</TD> |
---|
313 | </TR> |
---|
314 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
315 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
316 | <CODE> void</CODE></FONT></TD> |
---|
317 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#disconnectChannel(com.rabbitmq.client.impl.ChannelN)">disconnectChannel</A></B>(<A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A> channel)</CODE> |
---|
318 | |
---|
319 | <BR> |
---|
320 | Protected API - respond, in the driver thread, to a ShutdownSignal.</TD> |
---|
321 | </TR> |
---|
322 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
323 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
324 | <CODE> void</CODE></FONT></TD> |
---|
325 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#flush()">flush</A></B>()</CODE> |
---|
326 | |
---|
327 | <BR> |
---|
328 | Public API - flush the output buffers</TD> |
---|
329 | </TR> |
---|
330 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
331 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
332 | <CODE> java.net.InetAddress</CODE></FONT></TD> |
---|
333 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#getAddress()">getAddress</A></B>()</CODE> |
---|
334 | |
---|
335 | <BR> |
---|
336 | Retrieve the host.</TD> |
---|
337 | </TR> |
---|
338 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
339 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
340 | <CODE> int</CODE></FONT></TD> |
---|
341 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#getChannelMax()">getChannelMax</A></B>()</CODE> |
---|
342 | |
---|
343 | <BR> |
---|
344 | Get the negotiated maximum channel number.</TD> |
---|
345 | </TR> |
---|
346 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
347 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
348 | <CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> |
---|
349 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#getClientProperties()">getClientProperties</A></B>()</CODE> |
---|
350 | |
---|
351 | <BR> |
---|
352 | Get a copy of the map of client properties sent to the server</TD> |
---|
353 | </TR> |
---|
354 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
355 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
356 | <CODE> <A HREF="../../../../com/rabbitmq/client/impl/ExceptionHandler.html" title="interface in com.rabbitmq.client.impl">ExceptionHandler</A></CODE></FONT></TD> |
---|
357 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#getExceptionHandler()">getExceptionHandler</A></B>()</CODE> |
---|
358 | |
---|
359 | <BR> |
---|
360 | Protected API - retrieve the current ExceptionHandler</TD> |
---|
361 | </TR> |
---|
362 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
363 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
364 | <CODE> <A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A></CODE></FONT></TD> |
---|
365 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#getFrameHandler()">getFrameHandler</A></B>()</CODE> |
---|
366 | |
---|
367 | <BR> |
---|
368 | </TD> |
---|
369 | </TR> |
---|
370 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
371 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
372 | <CODE> int</CODE></FONT></TD> |
---|
373 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#getFrameMax()">getFrameMax</A></B>()</CODE> |
---|
374 | |
---|
375 | <BR> |
---|
376 | Get the negotiated maximum frame size.</TD> |
---|
377 | </TR> |
---|
378 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
379 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
380 | <CODE> int</CODE></FONT></TD> |
---|
381 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#getHeartbeat()">getHeartbeat</A></B>()</CODE> |
---|
382 | |
---|
383 | <BR> |
---|
384 | Get the negotiated heartbeat interval.</TD> |
---|
385 | </TR> |
---|
386 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
387 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
388 | <CODE> int</CODE></FONT></TD> |
---|
389 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#getPort()">getPort</A></B>()</CODE> |
---|
390 | |
---|
391 | <BR> |
---|
392 | Retrieve the port number.</TD> |
---|
393 | </TR> |
---|
394 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
395 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
396 | <CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> |
---|
397 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#getServerProperties()">getServerProperties</A></B>()</CODE> |
---|
398 | |
---|
399 | <BR> |
---|
400 | Retrieve the server properties.</TD> |
---|
401 | </TR> |
---|
402 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
403 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
404 | <CODE> void</CODE></FONT></TD> |
---|
405 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#handleConnectionClose(com.rabbitmq.client.Command)">handleConnectionClose</A></B>(<A HREF="../../../../com/rabbitmq/client/Command.html" title="interface in com.rabbitmq.client">Command</A> closeCommand)</CODE> |
---|
406 | |
---|
407 | <BR> |
---|
408 | </TD> |
---|
409 | </TR> |
---|
410 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
411 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
412 | <CODE> boolean</CODE></FONT></TD> |
---|
413 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#processControlCommand(com.rabbitmq.client.Command)">processControlCommand</A></B>(<A HREF="../../../../com/rabbitmq/client/Command.html" title="interface in com.rabbitmq.client">Command</A> c)</CODE> |
---|
414 | |
---|
415 | <BR> |
---|
416 | Handles incoming control commands on channel zero.</TD> |
---|
417 | </TR> |
---|
418 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
419 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
420 | <CODE> void</CODE></FONT></TD> |
---|
421 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#setHeartbeat(int)">setHeartbeat</A></B>(int heartbeat)</CODE> |
---|
422 | |
---|
423 | <BR> |
---|
424 | Protected API - set the heartbeat timeout.</TD> |
---|
425 | </TR> |
---|
426 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
427 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
428 | <CODE> <A HREF="../../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A></CODE></FONT></TD> |
---|
429 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#shutdown(java.lang.Object, boolean, java.lang.Throwable, boolean)">shutdown</A></B>(java.lang.Object reason, |
---|
430 | boolean initiatedByApplication, |
---|
431 | java.lang.Throwable cause, |
---|
432 | boolean notifyRpc)</CODE> |
---|
433 | |
---|
434 | <BR> |
---|
435 | Protected API - causes all attached channels to terminate (shutdown) with a ShutdownSignal |
---|
436 | built from the argument, and stops this connection from accepting further work from the |
---|
437 | application.</TD> |
---|
438 | </TR> |
---|
439 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
440 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
441 | <CODE> void</CODE></FONT></TD> |
---|
442 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#start()">start</A></B>()</CODE> |
---|
443 | |
---|
444 | <BR> |
---|
445 | Start up the connection, including the MainLoop thread.</TD> |
---|
446 | </TR> |
---|
447 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
448 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
449 | <CODE> java.lang.String</CODE></FONT></TD> |
---|
450 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#toString()">toString</A></B>()</CODE> |
---|
451 | |
---|
452 | <BR> |
---|
453 | </TD> |
---|
454 | </TR> |
---|
455 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
456 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
457 | <CODE> void</CODE></FONT></TD> |
---|
458 | <TD><CODE><B><A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.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> f)</CODE> |
---|
459 | |
---|
460 | <BR> |
---|
461 | Public API - sends a frame directly to the broker.</TD> |
---|
462 | </TR> |
---|
463 | </TABLE> |
---|
464 | <A NAME="methods_inherited_from_class_com.rabbitmq.client.impl.ShutdownNotifierComponent"><!-- --></A> |
---|
465 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
466 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
467 | <TH ALIGN="left"><B>Methods inherited from class com.rabbitmq.client.impl.<A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html" title="class in com.rabbitmq.client.impl">ShutdownNotifierComponent</A></B></TH> |
---|
468 | </TR> |
---|
469 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
470 | <TD><CODE><A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#addShutdownListener(com.rabbitmq.client.ShutdownListener)">addShutdownListener</A>, <A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#getCloseReason()">getCloseReason</A>, <A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#isOpen()">isOpen</A>, <A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#notifyListeners()">notifyListeners</A>, <A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#removeShutdownListener(com.rabbitmq.client.ShutdownListener)">removeShutdownListener</A>, <A HREF="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#setShutdownCauseIfOpen(com.rabbitmq.client.ShutdownSignalException)">setShutdownCauseIfOpen</A></CODE></TD> |
---|
471 | </TR> |
---|
472 | </TABLE> |
---|
473 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
---|
474 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
475 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
476 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
---|
477 | </TR> |
---|
478 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
479 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD> |
---|
480 | </TR> |
---|
481 | </TABLE> |
---|
482 | <A NAME="methods_inherited_from_class_com.rabbitmq.client.ShutdownNotifier"><!-- --></A> |
---|
483 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
484 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
---|
485 | <TH ALIGN="left"><B>Methods inherited from interface com.rabbitmq.client.<A HREF="../../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</A></B></TH> |
---|
486 | </TR> |
---|
487 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
488 | <TD><CODE><A HREF="../../../../com/rabbitmq/client/ShutdownNotifier.html#addShutdownListener(com.rabbitmq.client.ShutdownListener)">addShutdownListener</A>, <A HREF="../../../../com/rabbitmq/client/ShutdownNotifier.html#getCloseReason()">getCloseReason</A>, <A HREF="../../../../com/rabbitmq/client/ShutdownNotifier.html#isOpen()">isOpen</A>, <A HREF="../../../../com/rabbitmq/client/ShutdownNotifier.html#notifyListeners()">notifyListeners</A>, <A HREF="../../../../com/rabbitmq/client/ShutdownNotifier.html#removeShutdownListener(com.rabbitmq.client.ShutdownListener)">removeShutdownListener</A></CODE></TD> |
---|
489 | </TR> |
---|
490 | </TABLE> |
---|
491 | |
---|
492 | <P> |
---|
493 | |
---|
494 | <!-- ============ FIELD DETAIL =========== --> |
---|
495 | |
---|
496 | <A NAME="field_detail"><!-- --></A> |
---|
497 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
498 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
499 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
500 | <B>Field Detail</B></FONT></TH> |
---|
501 | </TR> |
---|
502 | </TABLE> |
---|
503 | |
---|
504 | <A NAME="HANDSHAKE_TIMEOUT"><!-- --></A><H3> |
---|
505 | HANDSHAKE_TIMEOUT</H3> |
---|
506 | <PRE> |
---|
507 | public static final int <B>HANDSHAKE_TIMEOUT</B></PRE> |
---|
508 | <DL> |
---|
509 | <DD>Timeout used while waiting for AMQP handshaking to complete (milliseconds) |
---|
510 | <P> |
---|
511 | <DL> |
---|
512 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.rabbitmq.client.impl.AMQConnection.HANDSHAKE_TIMEOUT">Constant Field Values</A></DL> |
---|
513 | </DL> |
---|
514 | |
---|
515 | <!-- ========= CONSTRUCTOR DETAIL ======== --> |
---|
516 | |
---|
517 | <A NAME="constructor_detail"><!-- --></A> |
---|
518 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
519 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
520 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
521 | <B>Constructor Detail</B></FONT></TH> |
---|
522 | </TR> |
---|
523 | </TABLE> |
---|
524 | |
---|
525 | <A NAME="AMQConnection(java.lang.String, java.lang.String, com.rabbitmq.client.impl.FrameHandler, java.util.concurrent.ExecutorService, java.lang.String, java.util.Map, int, int, int, com.rabbitmq.client.SaslConfig)"><!-- --></A><H3> |
---|
526 | AMQConnection</H3> |
---|
527 | <PRE> |
---|
528 | public <B>AMQConnection</B>(java.lang.String username, |
---|
529 | java.lang.String password, |
---|
530 | <A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A> frameHandler, |
---|
531 | java.util.concurrent.ExecutorService executor, |
---|
532 | java.lang.String virtualHost, |
---|
533 | java.util.Map<java.lang.String,java.lang.Object> clientProperties, |
---|
534 | int requestedFrameMax, |
---|
535 | int requestedChannelMax, |
---|
536 | int requestedHeartbeat, |
---|
537 | <A HREF="../../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client">SaslConfig</A> saslConfig)</PRE> |
---|
538 | <DL> |
---|
539 | <DD>Construct a new connection using a default ExeceptionHandler |
---|
540 | <P> |
---|
541 | <DL> |
---|
542 | <DT><B>Parameters:</B><DD><CODE>username</CODE> - name used to establish connection<DD><CODE>password</CODE> - for <code><b>username</b></code><DD><CODE>frameHandler</CODE> - for sending and receiving frames on this connection<DD><CODE>executor</CODE> - thread pool service for consumer threads for channels on this connection<DD><CODE>virtualHost</CODE> - virtual host of this connection<DD><CODE>clientProperties</CODE> - client info used in negotiating with the server<DD><CODE>requestedFrameMax</CODE> - max size of frame offered<DD><CODE>requestedChannelMax</CODE> - max number of channels offered<DD><CODE>requestedHeartbeat</CODE> - heart-beat in seconds offered<DD><CODE>saslConfig</CODE> - sasl configuration hook</DL> |
---|
543 | </DL> |
---|
544 | <HR> |
---|
545 | |
---|
546 | <A NAME="AMQConnection(java.lang.String, java.lang.String, com.rabbitmq.client.impl.FrameHandler, java.util.concurrent.ExecutorService, java.lang.String, java.util.Map, int, int, int, com.rabbitmq.client.SaslConfig, com.rabbitmq.client.impl.ExceptionHandler)"><!-- --></A><H3> |
---|
547 | AMQConnection</H3> |
---|
548 | <PRE> |
---|
549 | public <B>AMQConnection</B>(java.lang.String username, |
---|
550 | java.lang.String password, |
---|
551 | <A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A> frameHandler, |
---|
552 | java.util.concurrent.ExecutorService executor, |
---|
553 | java.lang.String virtualHost, |
---|
554 | java.util.Map<java.lang.String,java.lang.Object> clientProperties, |
---|
555 | int requestedFrameMax, |
---|
556 | int requestedChannelMax, |
---|
557 | int requestedHeartbeat, |
---|
558 | <A HREF="../../../../com/rabbitmq/client/SaslConfig.html" title="interface in com.rabbitmq.client">SaslConfig</A> saslConfig, |
---|
559 | <A HREF="../../../../com/rabbitmq/client/impl/ExceptionHandler.html" title="interface in com.rabbitmq.client.impl">ExceptionHandler</A> execeptionHandler)</PRE> |
---|
560 | <DL> |
---|
561 | <DD>Construct a new connection |
---|
562 | <P> |
---|
563 | <DL> |
---|
564 | <DT><B>Parameters:</B><DD><CODE>username</CODE> - name used to establish connection<DD><CODE>password</CODE> - for <code><b>username</b></code><DD><CODE>frameHandler</CODE> - for sending and receiving frames on this connection<DD><CODE>executor</CODE> - thread pool service for consumer threads for channels on this connection<DD><CODE>virtualHost</CODE> - virtual host of this connection<DD><CODE>clientProperties</CODE> - client info used in negotiating with the server<DD><CODE>requestedFrameMax</CODE> - max size of frame offered<DD><CODE>requestedChannelMax</CODE> - max number of channels offered<DD><CODE>requestedHeartbeat</CODE> - heart-beat in seconds offered<DD><CODE>saslConfig</CODE> - sasl configuration hook<DD><CODE>execeptionHandler</CODE> - handler for exceptions using this connection</DL> |
---|
565 | </DL> |
---|
566 | |
---|
567 | <!-- ============ METHOD DETAIL ========== --> |
---|
568 | |
---|
569 | <A NAME="method_detail"><!-- --></A> |
---|
570 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
571 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
572 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
573 | <B>Method Detail</B></FONT></TH> |
---|
574 | </TR> |
---|
575 | </TABLE> |
---|
576 | |
---|
577 | <A NAME="defaultClientProperties()"><!-- --></A><H3> |
---|
578 | defaultClientProperties</H3> |
---|
579 | <PRE> |
---|
580 | public static final java.util.Map<java.lang.String,java.lang.Object> <B>defaultClientProperties</B>()</PRE> |
---|
581 | <DL> |
---|
582 | <DD>Retrieve a copy of the default table of client properties that |
---|
583 | will be sent to the server during connection startup. This |
---|
584 | method is called when each new ConnectionFactory instance is |
---|
585 | constructed. |
---|
586 | <P> |
---|
587 | <DD><DL> |
---|
588 | </DL> |
---|
589 | </DD> |
---|
590 | <DD><DL> |
---|
591 | |
---|
592 | <DT><B>Returns:</B><DD>a map of client properties<DT><B>See Also:</B><DD><A HREF="../../../../com/rabbitmq/client/Connection.html#getClientProperties()"><CODE>Connection.getClientProperties()</CODE></A></DL> |
---|
593 | </DD> |
---|
594 | </DL> |
---|
595 | <HR> |
---|
596 | |
---|
597 | <A NAME="disconnectChannel(com.rabbitmq.client.impl.ChannelN)"><!-- --></A><H3> |
---|
598 | disconnectChannel</H3> |
---|
599 | <PRE> |
---|
600 | public final void <B>disconnectChannel</B>(<A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A> channel)</PRE> |
---|
601 | <DL> |
---|
602 | <DD>Protected API - respond, in the driver thread, to a ShutdownSignal. |
---|
603 | <P> |
---|
604 | <DD><DL> |
---|
605 | </DL> |
---|
606 | </DD> |
---|
607 | <DD><DL> |
---|
608 | <DT><B>Parameters:</B><DD><CODE>channel</CODE> - the channel to disconnect</DL> |
---|
609 | </DD> |
---|
610 | </DL> |
---|
611 | <HR> |
---|
612 | |
---|
613 | <A NAME="getAddress()"><!-- --></A><H3> |
---|
614 | getAddress</H3> |
---|
615 | <PRE> |
---|
616 | public java.net.InetAddress <B>getAddress</B>()</PRE> |
---|
617 | <DL> |
---|
618 | <DD>Retrieve the host. |
---|
619 | <P> |
---|
620 | <DD><DL> |
---|
621 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#getAddress()">getAddress</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
622 | </DD> |
---|
623 | <DD><DL> |
---|
624 | |
---|
625 | <DT><B>Returns:</B><DD>the hostname of the peer we're connected to.</DL> |
---|
626 | </DD> |
---|
627 | </DL> |
---|
628 | <HR> |
---|
629 | |
---|
630 | <A NAME="getPort()"><!-- --></A><H3> |
---|
631 | getPort</H3> |
---|
632 | <PRE> |
---|
633 | public int <B>getPort</B>()</PRE> |
---|
634 | <DL> |
---|
635 | <DD>Retrieve the port number. |
---|
636 | <P> |
---|
637 | <DD><DL> |
---|
638 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#getPort()">getPort</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
639 | </DD> |
---|
640 | <DD><DL> |
---|
641 | |
---|
642 | <DT><B>Returns:</B><DD>the port number of the peer we're connected to.</DL> |
---|
643 | </DD> |
---|
644 | </DL> |
---|
645 | <HR> |
---|
646 | |
---|
647 | <A NAME="getFrameHandler()"><!-- --></A><H3> |
---|
648 | getFrameHandler</H3> |
---|
649 | <PRE> |
---|
650 | public <A HREF="../../../../com/rabbitmq/client/impl/FrameHandler.html" title="interface in com.rabbitmq.client.impl">FrameHandler</A> <B>getFrameHandler</B>()</PRE> |
---|
651 | <DL> |
---|
652 | <DD><DL> |
---|
653 | </DL> |
---|
654 | </DD> |
---|
655 | <DD><DL> |
---|
656 | </DL> |
---|
657 | </DD> |
---|
658 | </DL> |
---|
659 | <HR> |
---|
660 | |
---|
661 | <A NAME="getServerProperties()"><!-- --></A><H3> |
---|
662 | getServerProperties</H3> |
---|
663 | <PRE> |
---|
664 | public java.util.Map<java.lang.String,java.lang.Object> <B>getServerProperties</B>()</PRE> |
---|
665 | <DL> |
---|
666 | <DD>Retrieve the server properties. |
---|
667 | <P> |
---|
668 | <DD><DL> |
---|
669 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#getServerProperties()">getServerProperties</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
670 | </DD> |
---|
671 | <DD><DL> |
---|
672 | |
---|
673 | <DT><B>Returns:</B><DD>a map of the server properties. This typically includes the product name and version of the server.</DL> |
---|
674 | </DD> |
---|
675 | </DL> |
---|
676 | <HR> |
---|
677 | |
---|
678 | <A NAME="start()"><!-- --></A><H3> |
---|
679 | start</H3> |
---|
680 | <PRE> |
---|
681 | public void <B>start</B>() |
---|
682 | throws java.io.IOException</PRE> |
---|
683 | <DL> |
---|
684 | <DD>Start up the connection, including the MainLoop thread. |
---|
685 | Sends the protocol |
---|
686 | version negotiation header, and runs through |
---|
687 | Connection.Start/.StartOk, Connection.Tune/.TuneOk, and then |
---|
688 | calls Connection.Open and waits for the OpenOk. Sets heart-beat |
---|
689 | and frame max values after tuning has taken place. |
---|
690 | <P> |
---|
691 | <DD><DL> |
---|
692 | </DL> |
---|
693 | </DD> |
---|
694 | <DD><DL> |
---|
695 | |
---|
696 | <DT><B>Throws:</B> |
---|
697 | <DD><CODE>java.io.IOException</CODE> - if an error is encountered |
---|
698 | either before, or during, protocol negotiation; |
---|
699 | sub-classes <A HREF="../../../../com/rabbitmq/client/ProtocolVersionMismatchException.html" title="class in com.rabbitmq.client"><CODE>ProtocolVersionMismatchException</CODE></A> and |
---|
700 | <A HREF="../../../../com/rabbitmq/client/PossibleAuthenticationFailureException.html" title="class in com.rabbitmq.client"><CODE>PossibleAuthenticationFailureException</CODE></A> will be thrown in the |
---|
701 | corresponding circumstances. If an exception is thrown, connection |
---|
702 | resources allocated can all be garbage collected when the connection |
---|
703 | object is no longer referenced.</DL> |
---|
704 | </DD> |
---|
705 | </DL> |
---|
706 | <HR> |
---|
707 | |
---|
708 | <A NAME="getChannelMax()"><!-- --></A><H3> |
---|
709 | getChannelMax</H3> |
---|
710 | <PRE> |
---|
711 | public int <B>getChannelMax</B>()</PRE> |
---|
712 | <DL> |
---|
713 | <DD>Get the negotiated maximum channel number. Usable channel |
---|
714 | numbers range from 1 to this number, inclusive. |
---|
715 | <P> |
---|
716 | <DD><DL> |
---|
717 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#getChannelMax()">getChannelMax</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
718 | </DD> |
---|
719 | <DD><DL> |
---|
720 | |
---|
721 | <DT><B>Returns:</B><DD>the maximum channel number permitted for this connection.</DL> |
---|
722 | </DD> |
---|
723 | </DL> |
---|
724 | <HR> |
---|
725 | |
---|
726 | <A NAME="getFrameMax()"><!-- --></A><H3> |
---|
727 | getFrameMax</H3> |
---|
728 | <PRE> |
---|
729 | public int <B>getFrameMax</B>()</PRE> |
---|
730 | <DL> |
---|
731 | <DD>Get the negotiated maximum frame size. |
---|
732 | <P> |
---|
733 | <DD><DL> |
---|
734 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#getFrameMax()">getFrameMax</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
735 | </DD> |
---|
736 | <DD><DL> |
---|
737 | |
---|
738 | <DT><B>Returns:</B><DD>the maximum frame size, in octets; zero if unlimited</DL> |
---|
739 | </DD> |
---|
740 | </DL> |
---|
741 | <HR> |
---|
742 | |
---|
743 | <A NAME="getHeartbeat()"><!-- --></A><H3> |
---|
744 | getHeartbeat</H3> |
---|
745 | <PRE> |
---|
746 | public int <B>getHeartbeat</B>()</PRE> |
---|
747 | <DL> |
---|
748 | <DD>Get the negotiated heartbeat interval. |
---|
749 | <P> |
---|
750 | <DD><DL> |
---|
751 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#getHeartbeat()">getHeartbeat</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
752 | </DD> |
---|
753 | <DD><DL> |
---|
754 | |
---|
755 | <DT><B>Returns:</B><DD>the heartbeat interval, in seconds; zero if none</DL> |
---|
756 | </DD> |
---|
757 | </DL> |
---|
758 | <HR> |
---|
759 | |
---|
760 | <A NAME="setHeartbeat(int)"><!-- --></A><H3> |
---|
761 | setHeartbeat</H3> |
---|
762 | <PRE> |
---|
763 | public void <B>setHeartbeat</B>(int heartbeat)</PRE> |
---|
764 | <DL> |
---|
765 | <DD>Protected API - set the heartbeat timeout. Should only be called |
---|
766 | during tuning. |
---|
767 | <P> |
---|
768 | <DD><DL> |
---|
769 | </DL> |
---|
770 | </DD> |
---|
771 | <DD><DL> |
---|
772 | </DL> |
---|
773 | </DD> |
---|
774 | </DL> |
---|
775 | <HR> |
---|
776 | |
---|
777 | <A NAME="getClientProperties()"><!-- --></A><H3> |
---|
778 | getClientProperties</H3> |
---|
779 | <PRE> |
---|
780 | public java.util.Map<java.lang.String,java.lang.Object> <B>getClientProperties</B>()</PRE> |
---|
781 | <DL> |
---|
782 | <DD><B>Description copied from interface: <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#getClientProperties()">Connection</A></CODE></B></DD> |
---|
783 | <DD>Get a copy of the map of client properties sent to the server |
---|
784 | <P> |
---|
785 | <DD><DL> |
---|
786 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#getClientProperties()">getClientProperties</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
787 | </DD> |
---|
788 | <DD><DL> |
---|
789 | |
---|
790 | <DT><B>Returns:</B><DD>a copy of the map of client properties</DL> |
---|
791 | </DD> |
---|
792 | </DL> |
---|
793 | <HR> |
---|
794 | |
---|
795 | <A NAME="getExceptionHandler()"><!-- --></A><H3> |
---|
796 | getExceptionHandler</H3> |
---|
797 | <PRE> |
---|
798 | public <A HREF="../../../../com/rabbitmq/client/impl/ExceptionHandler.html" title="interface in com.rabbitmq.client.impl">ExceptionHandler</A> <B>getExceptionHandler</B>()</PRE> |
---|
799 | <DL> |
---|
800 | <DD>Protected API - retrieve the current ExceptionHandler |
---|
801 | <P> |
---|
802 | <DD><DL> |
---|
803 | </DL> |
---|
804 | </DD> |
---|
805 | <DD><DL> |
---|
806 | </DL> |
---|
807 | </DD> |
---|
808 | </DL> |
---|
809 | <HR> |
---|
810 | |
---|
811 | <A NAME="createChannel(int)"><!-- --></A><H3> |
---|
812 | createChannel</H3> |
---|
813 | <PRE> |
---|
814 | public <A HREF="../../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A> <B>createChannel</B>(int channelNumber) |
---|
815 | throws java.io.IOException</PRE> |
---|
816 | <DL> |
---|
817 | <DD>Public API - Create a new channel, using the specified channel number if possible. |
---|
818 | <P> |
---|
819 | <DD><DL> |
---|
820 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#createChannel(int)">createChannel</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
821 | </DD> |
---|
822 | <DD><DL> |
---|
823 | <DT><B>Parameters:</B><DD><CODE>channelNumber</CODE> - the channel number to allocate |
---|
824 | <DT><B>Returns:</B><DD>a new channel descriptor, or null if this channel number is already in use |
---|
825 | <DT><B>Throws:</B> |
---|
826 | <DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL> |
---|
827 | </DD> |
---|
828 | </DL> |
---|
829 | <HR> |
---|
830 | |
---|
831 | <A NAME="createChannel()"><!-- --></A><H3> |
---|
832 | createChannel</H3> |
---|
833 | <PRE> |
---|
834 | public <A HREF="../../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A> <B>createChannel</B>() |
---|
835 | throws java.io.IOException</PRE> |
---|
836 | <DL> |
---|
837 | <DD>Public API - Create a new channel, using an internally allocated channel number. |
---|
838 | <P> |
---|
839 | <DD><DL> |
---|
840 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#createChannel()">createChannel</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
841 | </DD> |
---|
842 | <DD><DL> |
---|
843 | |
---|
844 | <DT><B>Returns:</B><DD>a new channel descriptor, or null if none is available |
---|
845 | <DT><B>Throws:</B> |
---|
846 | <DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL> |
---|
847 | </DD> |
---|
848 | </DL> |
---|
849 | <HR> |
---|
850 | |
---|
851 | <A NAME="writeFrame(com.rabbitmq.client.impl.Frame)"><!-- --></A><H3> |
---|
852 | writeFrame</H3> |
---|
853 | <PRE> |
---|
854 | public void <B>writeFrame</B>(<A HREF="../../../../com/rabbitmq/client/impl/Frame.html" title="class in com.rabbitmq.client.impl">Frame</A> f) |
---|
855 | throws java.io.IOException</PRE> |
---|
856 | <DL> |
---|
857 | <DD>Public API - sends a frame directly to the broker. |
---|
858 | <P> |
---|
859 | <DD><DL> |
---|
860 | </DL> |
---|
861 | </DD> |
---|
862 | <DD><DL> |
---|
863 | |
---|
864 | <DT><B>Throws:</B> |
---|
865 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
866 | </DD> |
---|
867 | </DL> |
---|
868 | <HR> |
---|
869 | |
---|
870 | <A NAME="flush()"><!-- --></A><H3> |
---|
871 | flush</H3> |
---|
872 | <PRE> |
---|
873 | public void <B>flush</B>() |
---|
874 | throws java.io.IOException</PRE> |
---|
875 | <DL> |
---|
876 | <DD>Public API - flush the output buffers |
---|
877 | <P> |
---|
878 | <DD><DL> |
---|
879 | </DL> |
---|
880 | </DD> |
---|
881 | <DD><DL> |
---|
882 | |
---|
883 | <DT><B>Throws:</B> |
---|
884 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
885 | </DD> |
---|
886 | </DL> |
---|
887 | <HR> |
---|
888 | |
---|
889 | <A NAME="processControlCommand(com.rabbitmq.client.Command)"><!-- --></A><H3> |
---|
890 | processControlCommand</H3> |
---|
891 | <PRE> |
---|
892 | public boolean <B>processControlCommand</B>(<A HREF="../../../../com/rabbitmq/client/Command.html" title="interface in com.rabbitmq.client">Command</A> c) |
---|
893 | throws java.io.IOException</PRE> |
---|
894 | <DL> |
---|
895 | <DD>Handles incoming control commands on channel zero. |
---|
896 | <P> |
---|
897 | <DD><DL> |
---|
898 | </DL> |
---|
899 | </DD> |
---|
900 | <DD><DL> |
---|
901 | |
---|
902 | <DT><B>Throws:</B> |
---|
903 | <DD><CODE>java.io.IOException</CODE><DT><B>See Also:</B><DD><A HREF="../../../../com/rabbitmq/client/impl/ChannelN.html#processAsync(com.rabbitmq.client.Command)"><CODE>ChannelN.processAsync(com.rabbitmq.client.Command)</CODE></A></DL> |
---|
904 | </DD> |
---|
905 | </DL> |
---|
906 | <HR> |
---|
907 | |
---|
908 | <A NAME="handleConnectionClose(com.rabbitmq.client.Command)"><!-- --></A><H3> |
---|
909 | handleConnectionClose</H3> |
---|
910 | <PRE> |
---|
911 | public void <B>handleConnectionClose</B>(<A HREF="../../../../com/rabbitmq/client/Command.html" title="interface in com.rabbitmq.client">Command</A> closeCommand)</PRE> |
---|
912 | <DL> |
---|
913 | <DD><DL> |
---|
914 | </DL> |
---|
915 | </DD> |
---|
916 | <DD><DL> |
---|
917 | </DL> |
---|
918 | </DD> |
---|
919 | </DL> |
---|
920 | <HR> |
---|
921 | |
---|
922 | <A NAME="shutdown(java.lang.Object, boolean, java.lang.Throwable, boolean)"><!-- --></A><H3> |
---|
923 | shutdown</H3> |
---|
924 | <PRE> |
---|
925 | public <A HREF="../../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A> <B>shutdown</B>(java.lang.Object reason, |
---|
926 | boolean initiatedByApplication, |
---|
927 | java.lang.Throwable cause, |
---|
928 | boolean notifyRpc)</PRE> |
---|
929 | <DL> |
---|
930 | <DD>Protected API - causes all attached channels to terminate (shutdown) with a ShutdownSignal |
---|
931 | built from the argument, and stops this connection from accepting further work from the |
---|
932 | application. <A HREF="../../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><CODE>ShutdownListener</CODE></A>s for the |
---|
933 | connection are notified when the main loop terminates. |
---|
934 | <P> |
---|
935 | <DD><DL> |
---|
936 | </DL> |
---|
937 | </DD> |
---|
938 | <DD><DL> |
---|
939 | <DT><B>Parameters:</B><DD><CODE>reason</CODE> - object being shutdown<DD><CODE>initiatedByApplication</CODE> - true if caused by a client command<DD><CODE>cause</CODE> - trigger exception which caused shutdown<DD><CODE>notifyRpc</CODE> - true if outstanding rpc should be informed of shutdown |
---|
940 | <DT><B>Returns:</B><DD>a shutdown signal built using the given arguments</DL> |
---|
941 | </DD> |
---|
942 | </DL> |
---|
943 | <HR> |
---|
944 | |
---|
945 | <A NAME="close()"><!-- --></A><H3> |
---|
946 | close</H3> |
---|
947 | <PRE> |
---|
948 | public void <B>close</B>() |
---|
949 | throws java.io.IOException</PRE> |
---|
950 | <DL> |
---|
951 | <DD>Public API - Close this connection and all its channels |
---|
952 | with the <A HREF="../../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code |
---|
953 | and message 'OK'. |
---|
954 | |
---|
955 | Waits for all the close operations to complete. |
---|
956 | <P> |
---|
957 | <DD><DL> |
---|
958 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#close()">close</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
959 | </DD> |
---|
960 | <DD><DL> |
---|
961 | |
---|
962 | <DT><B>Throws:</B> |
---|
963 | <DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL> |
---|
964 | </DD> |
---|
965 | </DL> |
---|
966 | <HR> |
---|
967 | |
---|
968 | <A NAME="close(int)"><!-- --></A><H3> |
---|
969 | close</H3> |
---|
970 | <PRE> |
---|
971 | public void <B>close</B>(int timeout) |
---|
972 | throws java.io.IOException</PRE> |
---|
973 | <DL> |
---|
974 | <DD>Public API - Close this connection and all its channels |
---|
975 | with the <A HREF="../../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code |
---|
976 | and message 'OK'. |
---|
977 | |
---|
978 | This method behaves in a similar way as <A HREF="../../../../com/rabbitmq/client/Connection.html#close()"><CODE>Connection.close()</CODE></A>, with the only difference |
---|
979 | that it waits with a provided timeout for all the close operations to |
---|
980 | complete. When timeout is reached the socket is forced to close. |
---|
981 | <P> |
---|
982 | <DD><DL> |
---|
983 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#close(int)">close</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
984 | </DD> |
---|
985 | <DD><DL> |
---|
986 | <DT><B>Parameters:</B><DD><CODE>timeout</CODE> - timeout (in milliseconds) for completing all the close-related |
---|
987 | operations, use -1 for infinity |
---|
988 | <DT><B>Throws:</B> |
---|
989 | <DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL> |
---|
990 | </DD> |
---|
991 | </DL> |
---|
992 | <HR> |
---|
993 | |
---|
994 | <A NAME="close(int, java.lang.String)"><!-- --></A><H3> |
---|
995 | close</H3> |
---|
996 | <PRE> |
---|
997 | public void <B>close</B>(int closeCode, |
---|
998 | java.lang.String closeMessage) |
---|
999 | throws java.io.IOException</PRE> |
---|
1000 | <DL> |
---|
1001 | <DD>Public API - Close this connection and all its channels. |
---|
1002 | |
---|
1003 | Waits for all the close operations to complete. |
---|
1004 | <P> |
---|
1005 | <DD><DL> |
---|
1006 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#close(int, java.lang.String)">close</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
1007 | </DD> |
---|
1008 | <DD><DL> |
---|
1009 | <DT><B>Parameters:</B><DD><CODE>closeCode</CODE> - the close code (See under "Reply Codes" in the AMQP specification)<DD><CODE>closeMessage</CODE> - a message indicating the reason for closing the connection |
---|
1010 | <DT><B>Throws:</B> |
---|
1011 | <DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL> |
---|
1012 | </DD> |
---|
1013 | </DL> |
---|
1014 | <HR> |
---|
1015 | |
---|
1016 | <A NAME="close(int, java.lang.String, int)"><!-- --></A><H3> |
---|
1017 | close</H3> |
---|
1018 | <PRE> |
---|
1019 | public void <B>close</B>(int closeCode, |
---|
1020 | java.lang.String closeMessage, |
---|
1021 | int timeout) |
---|
1022 | throws java.io.IOException</PRE> |
---|
1023 | <DL> |
---|
1024 | <DD>Public API - Close this connection and all its channels. |
---|
1025 | |
---|
1026 | Waits with the given timeout for all the close operations to complete. |
---|
1027 | When timeout is reached the socket is forced to close. |
---|
1028 | <P> |
---|
1029 | <DD><DL> |
---|
1030 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#close(int, java.lang.String, int)">close</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
1031 | </DD> |
---|
1032 | <DD><DL> |
---|
1033 | <DT><B>Parameters:</B><DD><CODE>closeCode</CODE> - the close code (See under "Reply Codes" in the AMQP specification)<DD><CODE>closeMessage</CODE> - a message indicating the reason for closing the connection<DD><CODE>timeout</CODE> - timeout (in milliseconds) for completing all the close-related |
---|
1034 | operations, use -1 for infinity |
---|
1035 | <DT><B>Throws:</B> |
---|
1036 | <DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL> |
---|
1037 | </DD> |
---|
1038 | </DL> |
---|
1039 | <HR> |
---|
1040 | |
---|
1041 | <A NAME="abort()"><!-- --></A><H3> |
---|
1042 | abort</H3> |
---|
1043 | <PRE> |
---|
1044 | public void <B>abort</B>()</PRE> |
---|
1045 | <DL> |
---|
1046 | <DD>Public API - Abort this connection and all its channels |
---|
1047 | with the <A HREF="../../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code |
---|
1048 | and message 'OK'. |
---|
1049 | |
---|
1050 | Forces the connection to close. |
---|
1051 | Any encountered exceptions in the close operations are silently discarded. |
---|
1052 | <P> |
---|
1053 | <DD><DL> |
---|
1054 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#abort()">abort</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
1055 | </DD> |
---|
1056 | <DD><DL> |
---|
1057 | </DL> |
---|
1058 | </DD> |
---|
1059 | </DL> |
---|
1060 | <HR> |
---|
1061 | |
---|
1062 | <A NAME="abort(int, java.lang.String)"><!-- --></A><H3> |
---|
1063 | abort</H3> |
---|
1064 | <PRE> |
---|
1065 | public void <B>abort</B>(int closeCode, |
---|
1066 | java.lang.String closeMessage)</PRE> |
---|
1067 | <DL> |
---|
1068 | <DD>Public API - Abort this connection and all its channels. |
---|
1069 | |
---|
1070 | Forces the connection to close and waits for all the close operations to complete. |
---|
1071 | Any encountered exceptions in the close operations are silently discarded. |
---|
1072 | <P> |
---|
1073 | <DD><DL> |
---|
1074 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#abort(int, java.lang.String)">abort</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
1075 | </DD> |
---|
1076 | <DD><DL> |
---|
1077 | <DT><B>Parameters:</B><DD><CODE>closeCode</CODE> - the close code (See under "Reply Codes" in the AMQP specification)<DD><CODE>closeMessage</CODE> - a message indicating the reason for closing the connection</DL> |
---|
1078 | </DD> |
---|
1079 | </DL> |
---|
1080 | <HR> |
---|
1081 | |
---|
1082 | <A NAME="abort(int)"><!-- --></A><H3> |
---|
1083 | abort</H3> |
---|
1084 | <PRE> |
---|
1085 | public void <B>abort</B>(int timeout)</PRE> |
---|
1086 | <DL> |
---|
1087 | <DD>Public API - Abort this connection and all its channels |
---|
1088 | with the <A HREF="../../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code |
---|
1089 | and message 'OK'. |
---|
1090 | |
---|
1091 | This method behaves in a similar way as <A HREF="../../../../com/rabbitmq/client/Connection.html#abort()"><CODE>Connection.abort()</CODE></A>, with the only difference |
---|
1092 | that it waits with a provided timeout for all the close operations to |
---|
1093 | complete. When timeout is reached the socket is forced to close. |
---|
1094 | <P> |
---|
1095 | <DD><DL> |
---|
1096 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#abort(int)">abort</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
1097 | </DD> |
---|
1098 | <DD><DL> |
---|
1099 | <DT><B>Parameters:</B><DD><CODE>timeout</CODE> - timeout (in milliseconds) for completing all the close-related |
---|
1100 | operations, use -1 for infinity</DL> |
---|
1101 | </DD> |
---|
1102 | </DL> |
---|
1103 | <HR> |
---|
1104 | |
---|
1105 | <A NAME="abort(int, java.lang.String, int)"><!-- --></A><H3> |
---|
1106 | abort</H3> |
---|
1107 | <PRE> |
---|
1108 | public void <B>abort</B>(int closeCode, |
---|
1109 | java.lang.String closeMessage, |
---|
1110 | int timeout)</PRE> |
---|
1111 | <DL> |
---|
1112 | <DD>Public API - Abort this connection and all its channels. |
---|
1113 | |
---|
1114 | Forces the connection to close and waits with the given timeout |
---|
1115 | for all the close operations to complete. When timeout is reached |
---|
1116 | the socket is forced to close. |
---|
1117 | Any encountered exceptions in the close operations are silently discarded. |
---|
1118 | <P> |
---|
1119 | <DD><DL> |
---|
1120 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/rabbitmq/client/Connection.html#abort(int, java.lang.String, int)">abort</A></CODE> in interface <CODE><A HREF="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></CODE></DL> |
---|
1121 | </DD> |
---|
1122 | <DD><DL> |
---|
1123 | <DT><B>Parameters:</B><DD><CODE>closeCode</CODE> - the close code (See under "Reply Codes" in the AMQP specification)<DD><CODE>closeMessage</CODE> - a message indicating the reason for closing the connection<DD><CODE>timeout</CODE> - timeout (in milliseconds) for completing all the close-related |
---|
1124 | operations, use -1 for infinity</DL> |
---|
1125 | </DD> |
---|
1126 | </DL> |
---|
1127 | <HR> |
---|
1128 | |
---|
1129 | <A NAME="close(int, java.lang.String, boolean, java.lang.Throwable)"><!-- --></A><H3> |
---|
1130 | close</H3> |
---|
1131 | <PRE> |
---|
1132 | public void <B>close</B>(int closeCode, |
---|
1133 | java.lang.String closeMessage, |
---|
1134 | boolean initiatedByApplication, |
---|
1135 | java.lang.Throwable cause) |
---|
1136 | throws java.io.IOException</PRE> |
---|
1137 | <DL> |
---|
1138 | <DD>Protected API - Delegates to <A HREF="../../../../com/rabbitmq/client/impl/AMQConnection.html#close(int, java.lang.String, boolean, java.lang.Throwable, int, boolean)"><CODE>the |
---|
1139 | six-argument close method</CODE></A>, passing -1 for the timeout, and |
---|
1140 | false for the abort flag. |
---|
1141 | <P> |
---|
1142 | <DD><DL> |
---|
1143 | </DL> |
---|
1144 | </DD> |
---|
1145 | <DD><DL> |
---|
1146 | |
---|
1147 | <DT><B>Throws:</B> |
---|
1148 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
1149 | </DD> |
---|
1150 | </DL> |
---|
1151 | <HR> |
---|
1152 | |
---|
1153 | <A NAME="close(int, java.lang.String, boolean, java.lang.Throwable, int, boolean)"><!-- --></A><H3> |
---|
1154 | close</H3> |
---|
1155 | <PRE> |
---|
1156 | public void <B>close</B>(int closeCode, |
---|
1157 | java.lang.String closeMessage, |
---|
1158 | boolean initiatedByApplication, |
---|
1159 | java.lang.Throwable cause, |
---|
1160 | int timeout, |
---|
1161 | boolean abort) |
---|
1162 | throws java.io.IOException</PRE> |
---|
1163 | <DL> |
---|
1164 | <DD>Protected API - Close this connection with the given code, message, source |
---|
1165 | and timeout value for all the close operations to complete. |
---|
1166 | Specifies if any encountered exceptions should be ignored. |
---|
1167 | <P> |
---|
1168 | <DD><DL> |
---|
1169 | </DL> |
---|
1170 | </DD> |
---|
1171 | <DD><DL> |
---|
1172 | |
---|
1173 | <DT><B>Throws:</B> |
---|
1174 | <DD><CODE>java.io.IOException</CODE></DL> |
---|
1175 | </DD> |
---|
1176 | </DL> |
---|
1177 | <HR> |
---|
1178 | |
---|
1179 | <A NAME="toString()"><!-- --></A><H3> |
---|
1180 | toString</H3> |
---|
1181 | <PRE> |
---|
1182 | public java.lang.String <B>toString</B>()</PRE> |
---|
1183 | <DL> |
---|
1184 | <DD><DL> |
---|
1185 | <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> |
---|
1186 | </DD> |
---|
1187 | <DD><DL> |
---|
1188 | </DL> |
---|
1189 | </DD> |
---|
1190 | </DL> |
---|
1191 | <!-- ========= END OF CLASS DATA ========= --> |
---|
1192 | <HR> |
---|
1193 | |
---|
1194 | |
---|
1195 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
1196 | <A NAME="navbar_bottom"><!-- --></A> |
---|
1197 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
1198 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
1199 | <TR> |
---|
1200 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
1201 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
1202 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
1203 | <TR ALIGN="center" VALIGN="top"> |
---|
1204 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
1205 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
1206 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
1207 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
1208 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
1209 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
1210 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
1211 | </TR> |
---|
1212 | </TABLE> |
---|
1213 | </TD> |
---|
1214 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
1215 | </EM> |
---|
1216 | </TD> |
---|
1217 | </TR> |
---|
1218 | |
---|
1219 | <TR> |
---|
1220 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
1221 | <A HREF="../../../../com/rabbitmq/client/impl/AMQCommand.html" title="class in com.rabbitmq.client.impl"><B>PREV CLASS</B></A> |
---|
1222 | <A HREF="../../../../com/rabbitmq/client/impl/AMQContentHeader.html" title="class in com.rabbitmq.client.impl"><B>NEXT CLASS</B></A></FONT></TD> |
---|
1223 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
1224 | <A HREF="../../../../index.html?com/rabbitmq/client/impl/AMQConnection.html" target="_top"><B>FRAMES</B></A> |
---|
1225 | <A HREF="AMQConnection.html" target="_top"><B>NO FRAMES</B></A> |
---|
1226 | <SCRIPT type="text/javascript"> |
---|
1227 | <!-- |
---|
1228 | if(window==top) { |
---|
1229 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
1230 | } |
---|
1231 | //--> |
---|
1232 | </SCRIPT> |
---|
1233 | <NOSCRIPT> |
---|
1234 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
1235 | </NOSCRIPT> |
---|
1236 | |
---|
1237 | |
---|
1238 | </FONT></TD> |
---|
1239 | </TR> |
---|
1240 | <TR> |
---|
1241 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
1242 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
1243 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
1244 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
1245 | </TR> |
---|
1246 | </TABLE> |
---|
1247 | <A NAME="skip-navbar_bottom"></A> |
---|
1248 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
1249 | |
---|
1250 | <HR> |
---|
1251 | |
---|
1252 | </BODY> |
---|
1253 | </HTML> |
---|