| <!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 (1.8.0_66) on Fri Jan 15 14:33:42 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Closeable (Apache Mina SSHD :: Core 1.1.0 API)</title> |
| <meta name="date" content="2016-01-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Closeable (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <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="class-use/Closeable.html">Use</a></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="../../../../org/apache/sshd/common/BuiltinFactory.Utils.html" title="class in org.apache.sshd.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/sshd/common/Factory.html" title="interface in org.apache.sshd.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/sshd/common/Closeable.html" target="_top">Frames</a></li> |
| <li><a href="Closeable.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">org.apache.sshd.common</div> |
| <h2 title="Interface Closeable" class="title">Interface Closeable</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a>, <a href="../../../../org/apache/sshd/client/channel/ClientChannel.html" title="interface in org.apache.sshd.client.channel">ClientChannel</a>, <a href="../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>, <a href="../../../../org/apache/sshd/common/session/ConnectionService.html" title="interface in org.apache.sshd.common.session">ConnectionService</a>, <a href="../../../../org/apache/sshd/common/io/IoAcceptor.html" title="interface in org.apache.sshd.common.io">IoAcceptor</a>, <a href="../../../../org/apache/sshd/common/io/IoConnector.html" title="interface in org.apache.sshd.common.io">IoConnector</a>, <a href="../../../../org/apache/sshd/common/io/IoInputStream.html" title="interface in org.apache.sshd.common.io">IoInputStream</a>, <a href="../../../../org/apache/sshd/common/io/IoOutputStream.html" title="interface in org.apache.sshd.common.io">IoOutputStream</a>, <a href="../../../../org/apache/sshd/common/io/IoService.html" title="interface in org.apache.sshd.common.io">IoService</a>, <a href="../../../../org/apache/sshd/common/io/IoServiceFactory.html" title="interface in org.apache.sshd.common.io">IoServiceFactory</a>, <a href="../../../../org/apache/sshd/common/io/IoSession.html" title="interface in org.apache.sshd.common.io">IoSession</a>, <a href="../../../../org/apache/sshd/server/channel/ServerChannel.html" title="interface in org.apache.sshd.server.channel">ServerChannel</a>, <a href="../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</a>, <a href="../../../../org/apache/sshd/common/Service.html" title="interface in org.apache.sshd.common">Service</a>, <a href="../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a>, <a href="../../../../org/apache/sshd/common/forward/TcpipForwarder.html" title="interface in org.apache.sshd.common.forward">TcpipForwarder</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/sshd/client/channel/AbstractClientChannel.html" title="class in org.apache.sshd.client.channel">AbstractClientChannel</a>, <a href="../../../../org/apache/sshd/client/session/AbstractClientSession.html" title="class in org.apache.sshd.client.session">AbstractClientSession</a>, <a href="../../../../org/apache/sshd/common/session/AbstractConnectionService.html" title="class in org.apache.sshd.common.session">AbstractConnectionService</a>, <a href="../../../../org/apache/sshd/common/io/AbstractIoServiceFactory.html" title="class in org.apache.sshd.common.io">AbstractIoServiceFactory</a>, <a href="../../../../org/apache/sshd/server/channel/AbstractServerChannel.html" title="class in org.apache.sshd.server.channel">AbstractServerChannel</a>, <a href="../../../../org/apache/sshd/server/session/AbstractServerSession.html" title="class in org.apache.sshd.server.session">AbstractServerSession</a>, <a href="../../../../org/apache/sshd/common/session/AbstractSession.html" title="class in org.apache.sshd.common.session">AbstractSession</a>, <a href="../../../../org/apache/sshd/agent/local/AgentForwardedChannel.html" title="class in org.apache.sshd.agent.local">AgentForwardedChannel</a>, <a href="../../../../org/apache/sshd/agent/unix/AgentForwardedChannel.html" title="class in org.apache.sshd.agent.unix">AgentForwardedChannel</a>, <a href="../../../../org/apache/sshd/common/channel/BufferedIoOutputStream.html" title="class in org.apache.sshd.common.channel">BufferedIoOutputStream</a>, <a href="../../../../org/apache/sshd/agent/local/ChannelAgentForwarding.html" title="class in org.apache.sshd.agent.local">ChannelAgentForwarding</a>, <a href="../../../../org/apache/sshd/agent/unix/ChannelAgentForwarding.html" title="class in org.apache.sshd.agent.unix">ChannelAgentForwarding</a>, <a href="../../../../org/apache/sshd/common/channel/ChannelAsyncInputStream.html" title="class in org.apache.sshd.common.channel">ChannelAsyncInputStream</a>, <a href="../../../../org/apache/sshd/common/channel/ChannelAsyncOutputStream.html" title="class in org.apache.sshd.common.channel">ChannelAsyncOutputStream</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelDirectTcpip.html" title="class in org.apache.sshd.client.channel">ChannelDirectTcpip</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelExec.html" title="class in org.apache.sshd.client.channel">ChannelExec</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelSession.html" title="class in org.apache.sshd.client.channel">ChannelSession</a>, <a href="../../../../org/apache/sshd/server/channel/ChannelSession.html" title="class in org.apache.sshd.server.channel">ChannelSession</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelShell.html" title="class in org.apache.sshd.client.channel">ChannelShell</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelSubsystem.html" title="class in org.apache.sshd.client.channel">ChannelSubsystem</a>, <a href="../../../../org/apache/sshd/client/session/ClientConnectionService.html" title="class in org.apache.sshd.client.session">ClientConnectionService</a>, <a href="../../../../org/apache/sshd/client/session/ClientSessionImpl.html" title="class in org.apache.sshd.client.session">ClientSessionImpl</a>, <a href="../../../../org/apache/sshd/client/session/ClientUserAuthService.html" title="class in org.apache.sshd.client.session">ClientUserAuthService</a>, <a href="../../../../org/apache/sshd/common/forward/DefaultTcpipForwarder.html" title="class in org.apache.sshd.common.forward">DefaultTcpipForwarder</a>, <a href="../../../../org/apache/sshd/common/io/mina/MinaAcceptor.html" title="class in org.apache.sshd.common.io.mina">MinaAcceptor</a>, <a href="../../../../org/apache/sshd/common/io/mina/MinaConnector.html" title="class in org.apache.sshd.common.io.mina">MinaConnector</a>, <a href="../../../../org/apache/sshd/common/io/mina/MinaService.html" title="class in org.apache.sshd.common.io.mina">MinaService</a>, <a href="../../../../org/apache/sshd/common/io/mina/MinaServiceFactory.html" title="class in org.apache.sshd.common.io.mina">MinaServiceFactory</a>, <a href="../../../../org/apache/sshd/common/io/mina/MinaSession.html" title="class in org.apache.sshd.common.io.mina">MinaSession</a>, <a href="../../../../org/apache/sshd/common/io/nio2/Nio2Acceptor.html" title="class in org.apache.sshd.common.io.nio2">Nio2Acceptor</a>, <a href="../../../../org/apache/sshd/common/io/nio2/Nio2Connector.html" title="class in org.apache.sshd.common.io.nio2">Nio2Connector</a>, <a href="../../../../org/apache/sshd/common/io/nio2/Nio2Service.html" title="class in org.apache.sshd.common.io.nio2">Nio2Service</a>, <a href="../../../../org/apache/sshd/common/io/nio2/Nio2ServiceFactory.html" title="class in org.apache.sshd.common.io.nio2">Nio2ServiceFactory</a>, <a href="../../../../org/apache/sshd/common/io/nio2/Nio2Session.html" title="class in org.apache.sshd.common.io.nio2">Nio2Session</a>, <a href="../../../../org/apache/sshd/client/channel/PtyCapableChannelSession.html" title="class in org.apache.sshd.client.channel">PtyCapableChannelSession</a>, <a href="../../../../org/apache/sshd/server/session/ServerConnectionService.html" title="class in org.apache.sshd.server.session">ServerConnectionService</a>, <a href="../../../../org/apache/sshd/server/session/ServerSessionImpl.html" title="class in org.apache.sshd.server.session">ServerSessionImpl</a>, <a href="../../../../org/apache/sshd/server/session/ServerUserAuthService.html" title="class in org.apache.sshd.server.session">ServerUserAuthService</a>, <a href="../../../../org/apache/sshd/common/forward/TcpipClientChannel.html" title="class in org.apache.sshd.common.forward">TcpipClientChannel</a>, <a href="../../../../org/apache/sshd/server/forward/TcpipServerChannel.html" title="class in org.apache.sshd.server.forward">TcpipServerChannel</a>, <a href="../../../../org/apache/sshd/server/x11/X11ForwardSupport.ChannelForwardedX11.html" title="class in org.apache.sshd.server.x11">X11ForwardSupport.ChannelForwardedX11</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Closeable</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a></pre> |
| <div class="block">A <code>Closeable</code> is a resource that can be closed. |
| The close method is invoked to release resources that the object is |
| holding.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/sshd/common/future/CloseFuture.html" title="interface in org.apache.sshd.common.future">CloseFuture</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/common/Closeable.html#close-boolean-">close</a></span>(boolean immediately)</code> |
| <div class="block">Close this resource asynchronously and return a future.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/common/Closeable.html#isClosed--">isClosed</a></span>()</code> |
| <div class="block">Returns <code>true</code> if this object has been closed.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/common/Closeable.html#isClosing--">isClosing</a></span>()</code> |
| <div class="block">Returns <code>true</code> if the <a href="../../../../org/apache/sshd/common/Closeable.html#close-boolean-"><code>close(boolean)</code></a> method |
| has been called.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.nio.channels.Channel"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.nio.channels.<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true#close--" title="class or interface in java.nio.channels">close</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true#isOpen--" title="class or interface in java.nio.channels">isOpen</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="close-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre><a href="../../../../org/apache/sshd/common/future/CloseFuture.html" title="interface in org.apache.sshd.common.future">CloseFuture</a> close(boolean immediately)</pre> |
| <div class="block">Close this resource asynchronously and return a future. |
| Resources support two closing modes: a graceful mode |
| which will cleanly close the resource and an immediate mode |
| which will close the resources abruptly.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>immediately</code> - <code>true</code> if the resource should be shut down abruptly, |
| <code>false</code> for a graceful close</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a future</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isClosed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isClosed</h4> |
| <pre>boolean isClosed()</pre> |
| <div class="block">Returns <code>true</code> if this object has been closed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if closing</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isClosing--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>isClosing</h4> |
| <pre>boolean isClosing()</pre> |
| <div class="block">Returns <code>true</code> if the <a href="../../../../org/apache/sshd/common/Closeable.html#close-boolean-"><code>close(boolean)</code></a> method |
| has been called. |
| Note that this method will return <code>true</code> even if |
| this <a href="../../../../org/apache/sshd/common/Closeable.html#isClosed--"><code>isClosed()</code></a> returns <code>true</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if closing</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> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <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="class-use/Closeable.html">Use</a></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="../../../../org/apache/sshd/common/BuiltinFactory.Utils.html" title="class in org.apache.sshd.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/sshd/common/Factory.html" title="interface in org.apache.sshd.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/sshd/common/Closeable.html" target="_top">Frames</a></li> |
| <li><a href="Closeable.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
