Context Navigation

Connection.html

Last change on this file was 33, checked in by amoreno, 11 years ago
new release version
File size: 25.9 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:09 GMT 2012 -->
6	<TITLE>
7	Connection
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="Connection";
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/ConfirmListener.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>
58	<A HREF="../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
59	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60	<A HREF="../../../index.html?com/rabbitmq/client/Connection.html" target="_top"><B>FRAMES</B></A>
61	<A HREF="Connection.html" target="_top"><B>NO FRAMES</B></A>
62	<SCRIPT type="text/javascript">
63	<!--
64	if(window==top) {
65	document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
66	}
67	//-->
68	</SCRIPT>
69	<NOSCRIPT>
70	<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
71	</NOSCRIPT>
72
73
74	</FONT></TD>
75	</TR>
76	<TR>
77	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78	SUMMARY: NESTED \| FIELD \| CONSTR \| <A HREF="#method_summary">METHOD</A></FONT></TD>
79	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80	DETAIL: FIELD \| CONSTR \| <A HREF="#method_detail">METHOD</A></FONT></TD>
81	</TR>
82	</TABLE>
83	<A NAME="skip-navbar_top"></A>
84	<!-- ========= END OF TOP NAVBAR ========= -->
85
86	<HR>
87	<!-- ======== START OF CLASS DATA ======== -->
88	<H2>
89	<FONT SIZE="-1">
90	com.rabbitmq.client</FONT>
91	<BR>
92	Interface Connection</H2>
93	<DL>
94	<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</A></DD>
95	</DL>
96	<DL>
97	<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/rabbitmq/client/impl/AMQConnection.html" title="class in com.rabbitmq.client.impl">AMQConnection</A></DD>
98	</DL>
99	<HR>
100	<DL>
101	<DT><PRE>public interface <B>Connection</B><DT>extends <A HREF="../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</A></DL>
102	</PRE>
103
104	<P>
105	Public API: Interface to an AMQ connection. See the see the <a href="http://www.amqp.org/">spec</a> for details.
106	<p>
107	To connect to a broker, fill in a <A HREF="../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client"><CODE>ConnectionFactory</CODE></A> and use a <A HREF="../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client"><CODE>ConnectionFactory</CODE></A> as follows:
108
109	<pre>
110	ConnectionFactory factory = new ConnectionFactory();
111	factory.setHost(hostName);
112	factory.setPort(portNumber);
113	factory.setVirtualHost(virtualHost);
114	factory.setUsername(username);
115	factory.setPassword(password);
116	Connection conn = factory.newConnection();
117
118	// Then open a channel:
119
120	Channel channel = conn.createChannel();
121	</pre>
122	Or, more compactly:
123
124	<pre>
125	ConnectionFactory factory = new ConnectionFactory();
126	factory.setUri("amqp://username:password@hostName:portNumber/virtualHost");
127	Connection conn = factory.newConnection();
128	Channel channel = conn.createChannel()
129	</pre>
130
131	Current implementations are thread-safe for code at the client API level,
132	and in fact thread-safe internally except for code within RPC calls.
133	<P>
134
135	<P>
136	<HR>
137
138	<P>
139
140	<!-- ========== METHOD SUMMARY =========== -->
141
142	<A NAME="method_summary"><!-- --></A>
143	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
146	<B>Method Summary</B></FONT></TH>
147	</TR>
148	<TR BGCOLOR="white" CLASS="TableRowColor">
149	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150	<CODE> void</CODE></FONT></TD>
151	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#abort()">abort</A></B>()</CODE>
152
153	<BR>
154	Abort this connection and all its channels
155	with the <A HREF="../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code
156	and message 'OK'.</TD>
157	</TR>
158	<TR BGCOLOR="white" CLASS="TableRowColor">
159	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160	<CODE> void</CODE></FONT></TD>
161	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#abort(int)">abort</A></B>(int timeout)</CODE>
162
163	<BR>
164	Abort this connection and all its channels
165	with the <A HREF="../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code
166	and message 'OK'.</TD>
167	</TR>
168	<TR BGCOLOR="white" CLASS="TableRowColor">
169	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170	<CODE> void</CODE></FONT></TD>
171	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#abort(int, java.lang.String)">abort</A></B>(int closeCode,
172	java.lang.String closeMessage)</CODE>
173
174	<BR>
175	Abort this connection and all its channels.</TD>
176	</TR>
177	<TR BGCOLOR="white" CLASS="TableRowColor">
178	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179	<CODE> void</CODE></FONT></TD>
180	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#abort(int, java.lang.String, int)">abort</A></B>(int closeCode,
181	java.lang.String closeMessage,
182	int timeout)</CODE>
183
184	<BR>
185	Abort this connection and all its channels.</TD>
186	</TR>
187	<TR BGCOLOR="white" CLASS="TableRowColor">
188	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189	<CODE> void</CODE></FONT></TD>
190	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#close()">close</A></B>()</CODE>
191
192	<BR>
193	Close this connection and all its channels
194	with the <A HREF="../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code
195	and message 'OK'.</TD>
196	</TR>
197	<TR BGCOLOR="white" CLASS="TableRowColor">
198	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199	<CODE> void</CODE></FONT></TD>
200	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#close(int)">close</A></B>(int timeout)</CODE>
201
202	<BR>
203	Close this connection and all its channels
204	with the <A HREF="../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code
205	and message 'OK'.</TD>
206	</TR>
207	<TR BGCOLOR="white" CLASS="TableRowColor">
208	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209	<CODE> void</CODE></FONT></TD>
210	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#close(int, java.lang.String)">close</A></B>(int closeCode,
211	java.lang.String closeMessage)</CODE>
212
213	<BR>
214	Close this connection and all its channels.</TD>
215	</TR>
216	<TR BGCOLOR="white" CLASS="TableRowColor">
217	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218	<CODE> void</CODE></FONT></TD>
219	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#close(int, java.lang.String, int)">close</A></B>(int closeCode,
220	java.lang.String closeMessage,
221	int timeout)</CODE>
222
223	<BR>
224	Close this connection and all its channels.</TD>
225	</TR>
226	<TR BGCOLOR="white" CLASS="TableRowColor">
227	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228	<CODE> <A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A></CODE></FONT></TD>
229	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#createChannel()">createChannel</A></B>()</CODE>
230
231	<BR>
232	Create a new channel, using an internally allocated channel number.</TD>
233	</TR>
234	<TR BGCOLOR="white" CLASS="TableRowColor">
235	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236	<CODE> <A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A></CODE></FONT></TD>
237	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#createChannel(int)">createChannel</A></B>(int channelNumber)</CODE>
238
239	<BR>
240	Create a new channel, using the specified channel number if possible.</TD>
241	</TR>
242	<TR BGCOLOR="white" CLASS="TableRowColor">
243	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244	<CODE> java.net.InetAddress</CODE></FONT></TD>
245	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#getAddress()">getAddress</A></B>()</CODE>
246
247	<BR>
248	Retrieve the host.</TD>
249	</TR>
250	<TR BGCOLOR="white" CLASS="TableRowColor">
251	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252	<CODE> int</CODE></FONT></TD>
253	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#getChannelMax()">getChannelMax</A></B>()</CODE>
254
255	<BR>
256	Get the negotiated maximum channel number.</TD>
257	</TR>
258	<TR BGCOLOR="white" CLASS="TableRowColor">
259	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260	<CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD>
261	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#getClientProperties()">getClientProperties</A></B>()</CODE>
262
263	<BR>
264	Get a copy of the map of client properties sent to the server</TD>
265	</TR>
266	<TR BGCOLOR="white" CLASS="TableRowColor">
267	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268	<CODE> int</CODE></FONT></TD>
269	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#getFrameMax()">getFrameMax</A></B>()</CODE>
270
271	<BR>
272	Get the negotiated maximum frame size.</TD>
273	</TR>
274	<TR BGCOLOR="white" CLASS="TableRowColor">
275	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276	<CODE> int</CODE></FONT></TD>
277	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#getHeartbeat()">getHeartbeat</A></B>()</CODE>
278
279	<BR>
280	Get the negotiated heartbeat interval.</TD>
281	</TR>
282	<TR BGCOLOR="white" CLASS="TableRowColor">
283	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
284	<CODE> int</CODE></FONT></TD>
285	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#getPort()">getPort</A></B>()</CODE>
286
287	<BR>
288	Retrieve the port number.</TD>
289	</TR>
290	<TR BGCOLOR="white" CLASS="TableRowColor">
291	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
292	<CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD>
293	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/Connection.html#getServerProperties()">getServerProperties</A></B>()</CODE>
294
295	<BR>
296	Retrieve the server properties.</TD>
297	</TR>
298	</TABLE>
299	<A NAME="methods_inherited_from_class_com.rabbitmq.client.ShutdownNotifier"><!-- --></A>
300	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
301	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
302	<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>
303	</TR>
304	<TR BGCOLOR="white" CLASS="TableRowColor">
305	<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>
306	</TR>
307	</TABLE>
308
309	<P>
310
311	<!-- ============ METHOD DETAIL ========== -->
312
313	<A NAME="method_detail"><!-- --></A>
314	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
315	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
316	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
317	<B>Method Detail</B></FONT></TH>
318	</TR>
319	</TABLE>
320
321	<A NAME="getAddress()"><!-- --></A><H3>
322	getAddress</H3>
323	<PRE>
324	java.net.InetAddress <B>getAddress</B>()</PRE>
325	<DL>
326	<DD>Retrieve the host.
327	<P>
328	<DD><DL>
329	</DL>
330	</DD>
331	<DD><DL>
332
333	<DT><B>Returns:</B><DD>the hostname of the peer we're connected to.</DL>
334	</DD>
335	</DL>
336	<HR>
337
338	<A NAME="getPort()"><!-- --></A><H3>
339	getPort</H3>
340	<PRE>
341	int <B>getPort</B>()</PRE>
342	<DL>
343	<DD>Retrieve the port number.
344	<P>
345	<DD><DL>
346	</DL>
347	</DD>
348	<DD><DL>
349
350	<DT><B>Returns:</B><DD>the port number of the peer we're connected to.</DL>
351	</DD>
352	</DL>
353	<HR>
354
355	<A NAME="getChannelMax()"><!-- --></A><H3>
356	getChannelMax</H3>
357	<PRE>
358	int <B>getChannelMax</B>()</PRE>
359	<DL>
360	<DD>Get the negotiated maximum channel number. Usable channel
361	numbers range from 1 to this number, inclusive.
362	<P>
363	<DD><DL>
364	</DL>
365	</DD>
366	<DD><DL>
367
368	<DT><B>Returns:</B><DD>the maximum channel number permitted for this connection.</DL>
369	</DD>
370	</DL>
371	<HR>
372
373	<A NAME="getFrameMax()"><!-- --></A><H3>
374	getFrameMax</H3>
375	<PRE>
376	int <B>getFrameMax</B>()</PRE>
377	<DL>
378	<DD>Get the negotiated maximum frame size.
379	<P>
380	<DD><DL>
381	</DL>
382	</DD>
383	<DD><DL>
384
385	<DT><B>Returns:</B><DD>the maximum frame size, in octets; zero if unlimited</DL>
386	</DD>
387	</DL>
388	<HR>
389
390	<A NAME="getHeartbeat()"><!-- --></A><H3>
391	getHeartbeat</H3>
392	<PRE>
393	int <B>getHeartbeat</B>()</PRE>
394	<DL>
395	<DD>Get the negotiated heartbeat interval.
396	<P>
397	<DD><DL>
398	</DL>
399	</DD>
400	<DD><DL>
401
402	<DT><B>Returns:</B><DD>the heartbeat interval, in seconds; zero if none</DL>
403	</DD>
404	</DL>
405	<HR>
406
407	<A NAME="getClientProperties()"><!-- --></A><H3>
408	getClientProperties</H3>
409	<PRE>
410	java.util.Map<java.lang.String,java.lang.Object> <B>getClientProperties</B>()</PRE>
411	<DL>
412	<DD>Get a copy of the map of client properties sent to the server
413	<P>
414	<DD><DL>
415	</DL>
416	</DD>
417	<DD><DL>
418
419	<DT><B>Returns:</B><DD>a copy of the map of client properties</DL>
420	</DD>
421	</DL>
422	<HR>
423
424	<A NAME="getServerProperties()"><!-- --></A><H3>
425	getServerProperties</H3>
426	<PRE>
427	java.util.Map<java.lang.String,java.lang.Object> <B>getServerProperties</B>()</PRE>
428	<DL>
429	<DD>Retrieve the server properties.
430	<P>
431	<DD><DL>
432	</DL>
433	</DD>
434	<DD><DL>
435
436	<DT><B>Returns:</B><DD>a map of the server properties. This typically includes the product name and version of the server.</DL>
437	</DD>
438	</DL>
439	<HR>
440
441	<A NAME="createChannel()"><!-- --></A><H3>
442	createChannel</H3>
443	<PRE>
444	<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A> <B>createChannel</B>()
445	throws java.io.IOException</PRE>
446	<DL>
447	<DD>Create a new channel, using an internally allocated channel number.
448	<P>
449	<DD><DL>
450	</DL>
451	</DD>
452	<DD><DL>
453
454	<DT><B>Returns:</B><DD>a new channel descriptor, or null if none is available
455	<DT><B>Throws:</B>
456	<DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL>
457	</DD>
458	</DL>
459	<HR>
460
461	<A NAME="createChannel(int)"><!-- --></A><H3>
462	createChannel</H3>
463	<PRE>
464	<A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A> <B>createChannel</B>(int channelNumber)
465	throws java.io.IOException</PRE>
466	<DL>
467	<DD>Create a new channel, using the specified channel number if possible.
468	<P>
469	<DD><DL>
470	</DL>
471	</DD>
472	<DD><DL>
473	<DT><B>Parameters:</B><DD><CODE>channelNumber</CODE> - the channel number to allocate
474	<DT><B>Returns:</B><DD>a new channel descriptor, or null if this channel number is already in use
475	<DT><B>Throws:</B>
476	<DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL>
477	</DD>
478	</DL>
479	<HR>
480
481	<A NAME="close()"><!-- --></A><H3>
482	close</H3>
483	<PRE>
484	void <B>close</B>()
485	throws java.io.IOException</PRE>
486	<DL>
487	<DD>Close this connection and all its channels
488	with the <A HREF="../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code
489	and message 'OK'.
490
491	Waits for all the close operations to complete.
492	<P>
493	<DD><DL>
494	</DL>
495	</DD>
496	<DD><DL>
497
498	<DT><B>Throws:</B>
499	<DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL>
500	</DD>
501	</DL>
502	<HR>
503
504	<A NAME="close(int, java.lang.String)"><!-- --></A><H3>
505	close</H3>
506	<PRE>
507	void <B>close</B>(int closeCode,
508	java.lang.String closeMessage)
509	throws java.io.IOException</PRE>
510	<DL>
511	<DD>Close this connection and all its channels.
512
513	Waits for all the close operations to complete.
514	<P>
515	<DD><DL>
516	</DL>
517	</DD>
518	<DD><DL>
519	<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
520	<DT><B>Throws:</B>
521	<DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL>
522	</DD>
523	</DL>
524	<HR>
525
526	<A NAME="close(int)"><!-- --></A><H3>
527	close</H3>
528	<PRE>
529	void <B>close</B>(int timeout)
530	throws java.io.IOException</PRE>
531	<DL>
532	<DD>Close this connection and all its channels
533	with the <A HREF="../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code
534	and message 'OK'.
535
536	This method behaves in a similar way as <A HREF="../../../com/rabbitmq/client/Connection.html#close()"><CODE>close()</CODE></A>, with the only difference
537	that it waits with a provided timeout for all the close operations to
538	complete. When timeout is reached the socket is forced to close.
539	<P>
540	<DD><DL>
541	</DL>
542	</DD>
543	<DD><DL>
544	<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - timeout (in milliseconds) for completing all the close-related
545	operations, use -1 for infinity
546	<DT><B>Throws:</B>
547	<DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL>
548	</DD>
549	</DL>
550	<HR>
551
552	<A NAME="close(int, java.lang.String, int)"><!-- --></A><H3>
553	close</H3>
554	<PRE>
555	void <B>close</B>(int closeCode,
556	java.lang.String closeMessage,
557	int timeout)
558	throws java.io.IOException</PRE>
559	<DL>
560	<DD>Close this connection and all its channels.
561
562	Waits with the given timeout for all the close operations to complete.
563	When timeout is reached the socket is forced to close.
564	<P>
565	<DD><DL>
566	</DL>
567	</DD>
568	<DD><DL>
569	<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
570	operations, use -1 for infinity
571	<DT><B>Throws:</B>
572	<DD><CODE>java.io.IOException</CODE> - if an I/O problem is encountered</DL>
573	</DD>
574	</DL>
575	<HR>
576
577	<A NAME="abort()"><!-- --></A><H3>
578	abort</H3>
579	<PRE>
580	void <B>abort</B>()</PRE>
581	<DL>
582	<DD>Abort this connection and all its channels
583	with the <A HREF="../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code
584	and message 'OK'.
585
586	Forces the connection to close.
587	Any encountered exceptions in the close operations are silently discarded.
588	<P>
589	<DD><DL>
590	</DL>
591	</DD>
592	<DD><DL>
593	</DL>
594	</DD>
595	</DL>
596	<HR>
597
598	<A NAME="abort(int, java.lang.String)"><!-- --></A><H3>
599	abort</H3>
600	<PRE>
601	void <B>abort</B>(int closeCode,
602	java.lang.String closeMessage)</PRE>
603	<DL>
604	<DD>Abort this connection and all its channels.
605
606	Forces the connection to close and waits for all the close operations to complete.
607	Any encountered exceptions in the close operations are silently discarded.
608	<P>
609	<DD><DL>
610	</DL>
611	</DD>
612	<DD><DL>
613	<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>
614	</DD>
615	</DL>
616	<HR>
617
618	<A NAME="abort(int)"><!-- --></A><H3>
619	abort</H3>
620	<PRE>
621	void <B>abort</B>(int timeout)</PRE>
622	<DL>
623	<DD>Abort this connection and all its channels
624	with the <A HREF="../../../com/rabbitmq/client/AMQP.html#REPLY_SUCCESS"><CODE>AMQP.REPLY_SUCCESS</CODE></A> close code
625	and message 'OK'.
626
627	This method behaves in a similar way as <A HREF="../../../com/rabbitmq/client/Connection.html#abort()"><CODE>abort()</CODE></A>, with the only difference
628	that it waits with a provided timeout for all the close operations to
629	complete. When timeout is reached the socket is forced to close.
630	<P>
631	<DD><DL>
632	</DL>
633	</DD>
634	<DD><DL>
635	<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - timeout (in milliseconds) for completing all the close-related
636	operations, use -1 for infinity</DL>
637	</DD>
638	</DL>
639	<HR>
640
641	<A NAME="abort(int, java.lang.String, int)"><!-- --></A><H3>
642	abort</H3>
643	<PRE>
644	void <B>abort</B>(int closeCode,
645	java.lang.String closeMessage,
646	int timeout)</PRE>
647	<DL>
648	<DD>Abort this connection and all its channels.
649
650	Forces the connection to close and waits with the given timeout
651	for all the close operations to complete. When timeout is reached
652	the socket is forced to close.
653	Any encountered exceptions in the close operations are silently discarded.
654	<P>
655	<DD><DL>
656	</DL>
657	</DD>
658	<DD><DL>
659	<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
660	operations, use -1 for infinity</DL>
661	</DD>
662	</DL>
663	<!-- ========= END OF CLASS DATA ========= -->
664	<HR>
665
666
667	<!-- ======= START OF BOTTOM NAVBAR ====== -->
668	<A NAME="navbar_bottom"><!-- --></A>
669	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
670	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
671	<TR>
672	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
673	<A NAME="navbar_bottom_firstrow"><!-- --></A>
674	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
675	<TR ALIGN="center" VALIGN="top">
676	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
677	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
678	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
679	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
680	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
681	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
682	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
683	</TR>
684	</TABLE>
685	</TD>
686	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
687	</EM>
688	</TD>
689	</TR>
690
691	<TR>
692	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
693	<A HREF="../../../com/rabbitmq/client/ConfirmListener.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>
694	<A HREF="../../../com/rabbitmq/client/ConnectionFactory.html" title="class in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
695	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
696	<A HREF="../../../index.html?com/rabbitmq/client/Connection.html" target="_top"><B>FRAMES</B></A>
697	<A HREF="Connection.html" target="_top"><B>NO FRAMES</B></A>
698	<SCRIPT type="text/javascript">
699	<!--
700	if(window==top) {
701	document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
702	}
703	//-->
704	</SCRIPT>
705	<NOSCRIPT>
706	<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
707	</NOSCRIPT>
708
709
710	</FONT></TD>
711	</TR>
712	<TR>
713	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
714	SUMMARY: NESTED \| FIELD \| CONSTR \| <A HREF="#method_summary">METHOD</A></FONT></TD>
715	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
716	DETAIL: FIELD \| CONSTR \| <A HREF="#method_detail">METHOD</A></FONT></TD>
717	</TR>
718	</TABLE>
719	<A NAME="skip-navbar_bottom"></A>
720	<!-- ======== END OF BOTTOM NAVBAR ======= -->
721
722	<HR>
723
724	</BODY>
725	</HTML>

Note: See TracBrowser for help on using the repository browser.

Context Navigation

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

Download in other formats: