EVOLUTION-MANAGER
Edit File: ShutdownNotifierComponent.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_91) on Thu Jan 14 10:04:52 GMT 2016 --> <title>ShutdownNotifierComponent</title> <meta name="date" content="2016-01-14"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="ShutdownNotifierComponent"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/rabbitmq/client/impl/SetQueue.html" title="class in com.rabbitmq.client.impl"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html" title="class in com.rabbitmq.client.impl"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/rabbitmq/client/impl/ShutdownNotifierComponent.html" target="_top">Frames</a></li> <li><a href="ShutdownNotifierComponent.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">com.rabbitmq.client.impl</div> <h2 title="Class ShutdownNotifierComponent" class="title">Class ShutdownNotifierComponent</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.rabbitmq.client.impl.ShutdownNotifierComponent</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</a></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <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></dd> </dl> <hr> <br> <pre>public class <span class="strong">ShutdownNotifierComponent</span> extends java.lang.Object implements <a href="../../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</a></pre> <div class="block">A class that manages <a href="../../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><code>ShutdownListener</code></a>s and remembers the reason for a shutdown. Both <a href="../../../../com/rabbitmq/client/Channel.html" title="interface in com.rabbitmq.client"><code>Channel</code></a>s and <a href="../../../../com/rabbitmq/client/Connection.html" title="interface in com.rabbitmq.client"><code>Connection</code></a>s have shutdown listeners.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#ShutdownNotifierComponent()">ShutdownNotifierComponent</a></strong>()</code> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#addShutdownListener(com.rabbitmq.client.ShutdownListener)">addShutdownListener</a></strong>(<a href="../../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client">ShutdownListener</a> listener)</code> <div class="block">Add shutdown listener.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#getCloseReason()">getCloseReason</a></strong>()</code> <div class="block">Get the shutdown reason object</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#isOpen()">isOpen</a></strong>()</code> <div class="block">Determine whether the component is currently open.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#notifyListeners()">notifyListeners</a></strong>()</code> <div class="block">Protected API - notify the listeners attached to the component</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#removeShutdownListener(com.rabbitmq.client.ShutdownListener)">removeShutdownListener</a></strong>(<a href="../../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client">ShutdownListener</a> listener)</code> <div class="block">Remove shutdown listener for the component.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../com/rabbitmq/client/impl/ShutdownNotifierComponent.html#setShutdownCauseIfOpen(com.rabbitmq.client.ShutdownSignalException)">setShutdownCauseIfOpen</a></strong>(<a href="../../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</a> sse)</code> <div class="block">Internal: this is the means of registering shutdown.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="ShutdownNotifierComponent()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>ShutdownNotifierComponent</h4> <pre>public ShutdownNotifierComponent()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="addShutdownListener(com.rabbitmq.client.ShutdownListener)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>addShutdownListener</h4> <pre>public void addShutdownListener(<a href="../../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client">ShutdownListener</a> listener)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#addShutdownListener(com.rabbitmq.client.ShutdownListener)">ShutdownNotifier</a></code></strong></div> <div class="block">Add shutdown listener. If the component is already closed, handler is fired immediately</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#addShutdownListener(com.rabbitmq.client.ShutdownListener)">addShutdownListener</a></code> in interface <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - <a href="../../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><code>ShutdownListener</code></a> to the component</dd></dl> </li> </ul> <a name="getCloseReason()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getCloseReason</h4> <pre>public <a href="../../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</a> getCloseReason()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#getCloseReason()">ShutdownNotifier</a></code></strong></div> <div class="block">Get the shutdown reason object</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#getCloseReason()">getCloseReason</a></code> in interface <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>ShutdownSignalException if component is closed, null otherwise</dd></dl> </li> </ul> <a name="notifyListeners()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>notifyListeners</h4> <pre>public void notifyListeners()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#notifyListeners()">ShutdownNotifier</a></code></strong></div> <div class="block">Protected API - notify the listeners attached to the component</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#notifyListeners()">notifyListeners</a></code> in interface <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</a></code></dd> <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><code>ShutdownListener</code></a></dd></dl> </li> </ul> <a name="removeShutdownListener(com.rabbitmq.client.ShutdownListener)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>removeShutdownListener</h4> <pre>public void removeShutdownListener(<a href="../../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client">ShutdownListener</a> listener)</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#removeShutdownListener(com.rabbitmq.client.ShutdownListener)">ShutdownNotifier</a></code></strong></div> <div class="block">Remove shutdown listener for the component.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#removeShutdownListener(com.rabbitmq.client.ShutdownListener)">removeShutdownListener</a></code> in interface <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - <a href="../../../../com/rabbitmq/client/ShutdownListener.html" title="interface in com.rabbitmq.client"><code>ShutdownListener</code></a> to be removed</dd></dl> </li> </ul> <a name="isOpen()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isOpen</h4> <pre>public boolean isOpen()</pre> <div class="block"><strong>Description copied from interface: <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#isOpen()">ShutdownNotifier</a></code></strong></div> <div class="block">Determine whether the component is currently open. Will return false if we are currently closing. Checking this method should be only for information, because of the race conditions - state can change after the call. Instead just execute and try to catch ShutdownSignalException and IOException</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html#isOpen()">isOpen</a></code> in interface <code><a href="../../../../com/rabbitmq/client/ShutdownNotifier.html" title="interface in com.rabbitmq.client">ShutdownNotifier</a></code></dd> <dt><span class="strong">Returns:</span></dt><dd>true when component is open, false otherwise</dd></dl> </li> </ul> <a name="setShutdownCauseIfOpen(com.rabbitmq.client.ShutdownSignalException)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>setShutdownCauseIfOpen</h4> <pre>public boolean setShutdownCauseIfOpen(<a href="../../../../com/rabbitmq/client/ShutdownSignalException.html" title="class in com.rabbitmq.client">ShutdownSignalException</a> sse)</pre> <div class="block">Internal: this is the means of registering shutdown.</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>sse</code> - the reason for the shutdown</dd> <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the component is open; <code>false</code> otherwise.</dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/rabbitmq/client/impl/SetQueue.html" title="class in com.rabbitmq.client.impl"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../com/rabbitmq/client/impl/SocketFrameHandler.html" title="class in com.rabbitmq.client.impl"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/rabbitmq/client/impl/ShutdownNotifierComponent.html" target="_top">Frames</a></li> <li><a href="ShutdownNotifierComponent.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> </body> </html>