Context Navigation

ShutdownSignalException.html

Last change on this file was 33, checked in by amoreno, 11 years ago
new release version
File size: 15.8 KB

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<!--NewPage-->
3	<HTML>
4	<HEAD>
5	<!-- Generated by javadoc (build 1.6.0_18) on Tue Dec 11 11:47:10 GMT 2012 -->
6	<TITLE>
7	ShutdownSignalException
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="ShutdownSignalException";
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/ShutdownNotifier.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>
58	<A HREF="../../../com/rabbitmq/client/StringRpcServer.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/ShutdownSignalException.html" target="_top"><B>FRAMES</B></A>
61	<A HREF="ShutdownSignalException.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 \| <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: FIELD \| <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</FONT>
91	<BR>
92	Class ShutdownSignalException</H2>
93	<PRE>
94	java.lang.Object
95	<IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.Throwable
96	<IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.Exception
97	<IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.RuntimeException
98	<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.rabbitmq.client.ShutdownSignalException</B>
99	</PRE>
100	<DL>
101	<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../com/rabbitmq/utility/SensibleClone.html" title="interface in com.rabbitmq.utility">SensibleClone</A><<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A>>, java.io.Serializable, java.lang.Cloneable</DD>
102	</DL>
103	<DL>
104	<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/rabbitmq/client/AlreadyClosedException.html" title="class in com.rabbitmq.client">AlreadyClosedException</A></DD>
105	</DL>
106	<HR>
107	<DL>
108	<DT><PRE>public class <B>ShutdownSignalException</B><DT>extends java.lang.RuntimeException<DT>implements <A HREF="../../../com/rabbitmq/utility/SensibleClone.html" title="interface in com.rabbitmq.utility">SensibleClone</A><<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A>></DL>
109	</PRE>
110
111	<P>
112	Encapsulates a shutdown condition for a connection to an AMQP broker.
113	Depending on HardError when calling
114	<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html#getReference()"><CODE>getReference()</CODE></A> we will
115	either get a reference to the Connection or Channel instance that fired
116	this exception.
117	<P>
118
119	<P>
120	<DL>
121	<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#com.rabbitmq.client.ShutdownSignalException">Serialized Form</A></DL>
122	<HR>
123
124	<P>
125
126	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
127
128	<A NAME="constructor_summary"><!-- --></A>
129	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
131	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
132	<B>Constructor Summary</B></FONT></TH>
133	</TR>
134	<TR BGCOLOR="white" CLASS="TableRowColor">
135	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html#ShutdownSignalException(boolean, boolean, java.lang.Object, java.lang.Object)">ShutdownSignalException</A></B>(boolean hardError,
136	boolean initiatedByApplication,
137	java.lang.Object reason,
138	java.lang.Object ref)</CODE>
139
140	<BR>
141	Construct a ShutdownSignalException from the arguments.</TD>
142	</TR>
143	</TABLE>
144
145	<!-- ========== METHOD SUMMARY =========== -->
146
147	<A NAME="method_summary"><!-- --></A>
148	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
150	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
151	<B>Method Summary</B></FONT></TH>
152	</TR>
153	<TR BGCOLOR="white" CLASS="TableRowColor">
154	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155	<CODE> java.lang.Object</CODE></FONT></TD>
156	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html#getReason()">getReason</A></B>()</CODE>
157
158	<BR>
159	</TD>
160	</TR>
161	<TR BGCOLOR="white" CLASS="TableRowColor">
162	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163	<CODE> java.lang.Object</CODE></FONT></TD>
164	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html#getReference()">getReference</A></B>()</CODE>
165
166	<BR>
167	</TD>
168	</TR>
169	<TR BGCOLOR="white" CLASS="TableRowColor">
170	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171	<CODE> boolean</CODE></FONT></TD>
172	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html#isHardError()">isHardError</A></B>()</CODE>
173
174	<BR>
175	</TD>
176	</TR>
177	<TR BGCOLOR="white" CLASS="TableRowColor">
178	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179	<CODE> boolean</CODE></FONT></TD>
180	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html#isInitiatedByApplication()">isInitiatedByApplication</A></B>()</CODE>
181
182	<BR>
183	</TD>
184	</TR>
185	<TR BGCOLOR="white" CLASS="TableRowColor">
186	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187	<CODE> <A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A></CODE></FONT></TD>
188	<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html#sensibleClone()">sensibleClone</A></B>()</CODE>
189
190	<BR>
191	Like Object.clone but sensible; in particular, public and declared to return
192	the right type.</TD>
193	</TR>
194	</TABLE>
195	<A NAME="methods_inherited_from_class_java.lang.Throwable"><!-- --></A>
196	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
197	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
198	<TH ALIGN="left"><B>Methods inherited from class java.lang.Throwable</B></TH>
199	</TR>
200	<TR BGCOLOR="white" CLASS="TableRowColor">
201	<TD><CODE>fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</CODE></TD>
202	</TR>
203	</TABLE>
204	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
205	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
206	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
207	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
208	</TR>
209	<TR BGCOLOR="white" CLASS="TableRowColor">
210	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
211	</TR>
212	</TABLE>
213
214	<P>
215
216	<!-- ========= CONSTRUCTOR DETAIL ======== -->
217
218	<A NAME="constructor_detail"><!-- --></A>
219	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
220	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
221	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
222	<B>Constructor Detail</B></FONT></TH>
223	</TR>
224	</TABLE>
225
226	<A NAME="ShutdownSignalException(boolean, boolean, java.lang.Object, java.lang.Object)"><!-- --></A><H3>
227	ShutdownSignalException</H3>
228	<PRE>
229	public <B>ShutdownSignalException</B>(boolean hardError,
230	boolean initiatedByApplication,
231	java.lang.Object reason,
232	java.lang.Object ref)</PRE>
233	<DL>
234	<DD>Construct a ShutdownSignalException from the arguments.
235	<P>
236	<DL>
237	<DT><B>Parameters:</B><DD><CODE>hardError</CODE> - the relevant hard error<DD><CODE>initiatedByApplication</CODE> - if the shutdown was client-initiated<DD><CODE>reason</CODE> - Object describing the origin of the exception<DD><CODE>ref</CODE> - Reference to Connection or Channel that fired the signal</DL>
238	</DL>
239
240	<!-- ============ METHOD DETAIL ========== -->
241
242	<A NAME="method_detail"><!-- --></A>
243	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
244	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
245	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
246	<B>Method Detail</B></FONT></TH>
247	</TR>
248	</TABLE>
249
250	<A NAME="isHardError()"><!-- --></A><H3>
251	isHardError</H3>
252	<PRE>
253	public boolean <B>isHardError</B>()</PRE>
254	<DL>
255	<DD><DL>
256	</DL>
257	</DD>
258	<DD><DL>
259
260	<DT><B>Returns:</B><DD>true if this signals a connection error, or false if a channel error</DL>
261	</DD>
262	</DL>
263	<HR>
264
265	<A NAME="isInitiatedByApplication()"><!-- --></A><H3>
266	isInitiatedByApplication</H3>
267	<PRE>
268	public boolean <B>isInitiatedByApplication</B>()</PRE>
269	<DL>
270	<DD><DL>
271	</DL>
272	</DD>
273	<DD><DL>
274
275	<DT><B>Returns:</B><DD>true if this exception was caused by explicit application
276	action; false if it originated with the broker or as a result
277	of detectable non-deliberate application failure</DL>
278	</DD>
279	</DL>
280	<HR>
281
282	<A NAME="getReason()"><!-- --></A><H3>
283	getReason</H3>
284	<PRE>
285	public java.lang.Object <B>getReason</B>()</PRE>
286	<DL>
287	<DD><DL>
288	</DL>
289	</DD>
290	<DD><DL>
291
292	<DT><B>Returns:</B><DD>the reason object, if any</DL>
293	</DD>
294	</DL>
295	<HR>
296
297	<A NAME="getReference()"><!-- --></A><H3>
298	getReference</H3>
299	<PRE>
300	public java.lang.Object <B>getReference</B>()</PRE>
301	<DL>
302	<DD><DL>
303	</DL>
304	</DD>
305	<DD><DL>
306
307	<DT><B>Returns:</B><DD>Reference to Connection or Channel object that fired the signal</DL>
308	</DD>
309	</DL>
310	<HR>
311
312	<A NAME="sensibleClone()"><!-- --></A><H3>
313	sensibleClone</H3>
314	<PRE>
315	public <A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A> <B>sensibleClone</B>()</PRE>
316	<DL>
317	<DD><B>Description copied from interface: <CODE><A HREF="../../../com/rabbitmq/utility/SensibleClone.html#sensibleClone()">SensibleClone</A></CODE></B></DD>
318	<DD>Like Object.clone but sensible; in particular, public and declared to return
319	the right type.
320	<P>
321	<DD><DL>
322	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../com/rabbitmq/utility/SensibleClone.html#sensibleClone()">sensibleClone</A></CODE> in interface <CODE><A HREF="../../../com/rabbitmq/utility/SensibleClone.html" title="interface in com.rabbitmq.utility">SensibleClone</A><<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A>></CODE></DL>
323	</DD>
324	<DD><DL>
325	</DL>
326	</DD>
327	</DL>
328	<!-- ========= END OF CLASS DATA ========= -->
329	<HR>
330
331
332	<!-- ======= START OF BOTTOM NAVBAR ====== -->
333	<A NAME="navbar_bottom"><!-- --></A>
334	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
335	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
336	<TR>
337	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
338	<A NAME="navbar_bottom_firstrow"><!-- --></A>
339	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
340	<TR ALIGN="center" VALIGN="top">
341	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
342	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
343	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
344	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
345	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
346	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
347	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
348	</TR>
349	</TABLE>
350	</TD>
351	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
352	</EM>
353	</TD>
354	</TR>
355
356	<TR>
357	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
358	<A HREF="../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>
359	<A HREF="../../../com/rabbitmq/client/StringRpcServer.html" title="class in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
360	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
361	<A HREF="../../../index.html?com/rabbitmq/client/ShutdownSignalException.html" target="_top"><B>FRAMES</B></A>
362	<A HREF="ShutdownSignalException.html" target="_top"><B>NO FRAMES</B></A>
363	<SCRIPT type="text/javascript">
364	<!--
365	if(window==top) {
366	document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
367	}
368	//-->
369	</SCRIPT>
370	<NOSCRIPT>
371	<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
372	</NOSCRIPT>
373
374
375	</FONT></TD>
376	</TR>
377	<TR>
378	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
379	SUMMARY: NESTED \| FIELD \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
380	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
381	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
382	</TR>
383	</TABLE>
384	<A NAME="skip-navbar_bottom"></A>
385	<!-- ======== END OF BOTTOM NAVBAR ======= -->
386
387	<HR>
388
389	</BODY>
390	</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/ShutdownSignalException.html

Download in other formats: