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

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

new release version
File size: 13.0 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>
7ShutdownNotifier
8</TITLE>
9
10<META NAME="date" CONTENT="2012-12-11">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="ShutdownNotifier";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47  </TR>
48</TABLE>
49</TD>
50<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51</EM>
52</TD>
53</TR>
54
55<TR>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57&nbsp;<A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
58&nbsp;<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.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/ShutdownNotifier.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="ShutdownNotifier.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62&nbsp;<SCRIPT type="text/javascript">
63  <!--
64  if(window==top) {
65    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
66  }
67  //-->
68</SCRIPT>
69<NOSCRIPT>
70  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
71</NOSCRIPT>
72
73
74</FONT></TD>
75</TR>
76<TR>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81</TR>
82</TABLE>
83<A NAME="skip-navbar_top"></A>
84<!-- ========= END OF TOP NAVBAR ========= -->
85
86<HR>
87<!-- ======== START OF CLASS DATA ======== -->
88<H2>
89<FONT SIZE="-1">
90com.rabbitmq.client</FONT>
91<BR>
92Interface ShutdownNotifier</H2>
93<DL>
94<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client">Channel</A>, <A HREF="../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client">Connection</A></DD>
95</DL>
96<DL>
97<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/rabbitmq/client/impl/AMQChannel.html" title="class in com.rabbitmq.client.impl">AMQChannel</A>, <A HREF="../../../com/rabbitmq/client/impl/AMQConnection.html" title="class in com.rabbitmq.client.impl">AMQConnection</A>, <A HREF="../../../com/rabbitmq/client/impl/ChannelN.html" title="class in com.rabbitmq.client.impl">ChannelN</A>, <A HREF="../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html" title="class in com.rabbitmq.client.impl">ShutdownNotifierComponent</A></DD>
98</DL>
99<HR>
100<DL>
101<DT><PRE>public interface <B>ShutdownNotifier</B></DL>
102</PRE>
103
104<P>
105Interface for components that are shutdown capable and
106 that allow listeners to be added for shutdown signals
107<P>
108
109<P>
110<DL>
111<DT><B>See Also:</B><DD><A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><CODE>ShutdownListener</CODE></A>,
112<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client"><CODE>ShutdownSignalException</CODE></A></DL>
113<HR>
114
115<P>
116
117<!-- ========== METHOD SUMMARY =========== -->
118
119<A NAME="method_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>Method 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>&nbsp;void</CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownNotifier.html#addShutdownListener(com.rabbitmq.client.ShutdownListener)">addShutdownListener</A></B>(<A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client">ShutdownListener</A>&nbsp;listener)</CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add shutdown listener.</TD>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135<CODE>&nbsp;<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A></CODE></FONT></TD>
136<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownNotifier.html#getCloseReason()">getCloseReason</A></B>()</CODE>
137
138<BR>
139&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the shutdown reason object</TD>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
143<CODE>&nbsp;boolean</CODE></FONT></TD>
144<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownNotifier.html#isOpen()">isOpen</A></B>()</CODE>
145
146<BR>
147&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine whether the component is currently open.</TD>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<CODE>&nbsp;void</CODE></FONT></TD>
152<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownNotifier.html#notifyListeners()">notifyListeners</A></B>()</CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Protected API - notify the listeners attached to the component</TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<CODE>&nbsp;void</CODE></FONT></TD>
160<TD><CODE><B><A HREF="../../../com/rabbitmq/client/ShutdownNotifier.html#removeShutdownListener(com.rabbitmq.client.ShutdownListener)">removeShutdownListener</A></B>(<A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client">ShutdownListener</A>&nbsp;listener)</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove shutdown listener for the component.</TD>
164</TR>
165</TABLE>
166&nbsp;
167<P>
168
169<!-- ============ METHOD DETAIL ========== -->
170
171<A NAME="method_detail"><!-- --></A>
172<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
174<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
175<B>Method Detail</B></FONT></TH>
176</TR>
177</TABLE>
178
179<A NAME="addShutdownListener(com.rabbitmq.client.ShutdownListener)"><!-- --></A><H3>
180addShutdownListener</H3>
181<PRE>
182void <B>addShutdownListener</B>(<A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client">ShutdownListener</A>&nbsp;listener)</PRE>
183<DL>
184<DD>Add shutdown listener.
185 If the component is already closed, handler is fired immediately
186<P>
187<DD><DL>
188<DT><B>Parameters:</B><DD><CODE>listener</CODE> - <A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><CODE>ShutdownListener</CODE></A> to the component</DL>
189</DD>
190</DL>
191<HR>
192
193<A NAME="removeShutdownListener(com.rabbitmq.client.ShutdownListener)"><!-- --></A><H3>
194removeShutdownListener</H3>
195<PRE>
196void <B>removeShutdownListener</B>(<A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client">ShutdownListener</A>&nbsp;listener)</PRE>
197<DL>
198<DD>Remove shutdown listener for the component.
199<P>
200<DD><DL>
201<DT><B>Parameters:</B><DD><CODE>listener</CODE> - <A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><CODE>ShutdownListener</CODE></A> to be removed</DL>
202</DD>
203</DL>
204<HR>
205
206<A NAME="getCloseReason()"><!-- --></A><H3>
207getCloseReason</H3>
208<PRE>
209<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</A> <B>getCloseReason</B>()</PRE>
210<DL>
211<DD>Get the shutdown reason object
212<P>
213<DD><DL>
214
215<DT><B>Returns:</B><DD>ShutdownSignalException if component is closed, null otherwise</DL>
216</DD>
217</DL>
218<HR>
219
220<A NAME="notifyListeners()"><!-- --></A><H3>
221notifyListeners</H3>
222<PRE>
223void <B>notifyListeners</B>()</PRE>
224<DL>
225<DD>Protected API - notify the listeners attached to the component
226<P>
227<DD><DL>
228<DT><B>See Also:</B><DD><A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><CODE>ShutdownListener</CODE></A></DL>
229</DD>
230</DL>
231<HR>
232
233<A NAME="isOpen()"><!-- --></A><H3>
234isOpen</H3>
235<PRE>
236boolean <B>isOpen</B>()</PRE>
237<DL>
238<DD>Determine whether the component is currently open.
239 Will return false if we are currently closing.
240 Checking this method should be only for information,
241 because of the race conditions - state can change after the call.
242 Instead just execute and try to catch ShutdownSignalException
243 and IOException
244<P>
245<DD><DL>
246
247<DT><B>Returns:</B><DD>true when component is open, false otherwise</DL>
248</DD>
249</DL>
250<!-- ========= END OF CLASS DATA ========= -->
251<HR>
252
253
254<!-- ======= START OF BOTTOM NAVBAR ====== -->
255<A NAME="navbar_bottom"><!-- --></A>
256<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
257<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
258<TR>
259<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
260<A NAME="navbar_bottom_firstrow"><!-- --></A>
261<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
262  <TR ALIGN="center" VALIGN="top">
263  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
264  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
265  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
266  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
267  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
268  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
269  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
270  </TR>
271</TABLE>
272</TD>
273<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
274</EM>
275</TD>
276</TR>
277
278<TR>
279<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
280&nbsp;<A HREF="../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><B>PREV CLASS</B></A>&nbsp;
281&nbsp;<A HREF="../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client"><B>NEXT CLASS</B></A></FONT></TD>
282<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
283  <A HREF="../../../index.html?com/rabbitmq/client/ShutdownNotifier.html" target="_top"><B>FRAMES</B></A>  &nbsp;
284&nbsp;<A HREF="ShutdownNotifier.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
285&nbsp;<SCRIPT type="text/javascript">
286  <!--
287  if(window==top) {
288    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
289  }
290  //-->
291</SCRIPT>
292<NOSCRIPT>
293  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
294</NOSCRIPT>
295
296
297</FONT></TD>
298</TR>
299<TR>
300<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
301  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
302<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
303DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
304</TR>
305</TABLE>
306<A NAME="skip-navbar_bottom"></A>
307<!-- ======== END OF BOTTOM NAVBAR ======= -->
308
309<HR>
310
311</BODY>
312</HTML>
Note: See TracBrowser for help on using the repository browser.