| <!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>ChannelListener (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="ChannelListener (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":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/ChannelListener.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/channel/ChannelFactory.html" title="interface in org.apache.sshd.common.channel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/channel/ChannelListenerManager.html" title="interface in org.apache.sshd.common.channel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/channel/ChannelListener.html" target="_top">Frames</a></li> |
| <li><a href="ChannelListener.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.channel</div> |
| <h2 title="Interface ChannelListener" class="title">Interface ChannelListener</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/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ChannelListener</span> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EventListener.html?is-external=true" title="class or interface in java.util">EventListener</a></pre> |
| <div class="block">Provides a simple listener for client / server channels being established |
| or torn down. <B>Note:</B> for server-side listeners, some of the established |
| channels may be <U>client</U> - especially where connection proxy or forwarding |
| is concerned</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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/channel/ChannelListener.html#channelClosed-org.apache.sshd.common.channel.Channel-">channelClosed</a></span>(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel)</code> |
| <div class="block">Called to inform about a channel being closed.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/channel/ChannelListener.html#channelInitialized-org.apache.sshd.common.channel.Channel-">channelInitialized</a></span>(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel)</code> |
| <div class="block">Called to inform about initial setup of a channel via the |
| <a href="../../../../../org/apache/sshd/common/channel/Channel.html#init-org.apache.sshd.common.session.ConnectionService-org.apache.sshd.common.session.Session-int-"><code>Channel.init(org.apache.sshd.common.session.ConnectionService, org.apache.sshd.common.session.Session, int)</code></a> |
| method.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/channel/ChannelListener.html#channelOpenFailure-org.apache.sshd.common.channel.Channel-java.lang.Throwable-">channelOpenFailure</a></span>(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> reason)</code> |
| <div class="block">Called to inform about the failure to open a channel</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sshd/common/channel/ChannelListener.html#channelOpenSuccess-org.apache.sshd.common.channel.Channel-">channelOpenSuccess</a></span>(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel)</code> |
| <div class="block">Called to inform about a channel being successfully opened for a |
| session.</div> |
| </td> |
| </tr> |
| </table> |
| </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="channelInitialized-org.apache.sshd.common.channel.Channel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>channelInitialized</h4> |
| <pre>void channelInitialized(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel)</pre> |
| <div class="block">Called to inform about initial setup of a channel via the |
| <a href="../../../../../org/apache/sshd/common/channel/Channel.html#init-org.apache.sshd.common.session.ConnectionService-org.apache.sshd.common.session.Session-int-"><code>Channel.init(org.apache.sshd.common.session.ConnectionService, org.apache.sshd.common.session.Session, int)</code></a> |
| method. <B>Note:</B> this method is guaranteed to be called |
| before either of the <a href="../../../../../org/apache/sshd/common/channel/ChannelListener.html#channelOpenSuccess-org.apache.sshd.common.channel.Channel-"><code>channelOpenSuccess(Channel)</code></a> or |
| <a href="../../../../../org/apache/sshd/common/channel/ChannelListener.html#channelOpenFailure-org.apache.sshd.common.channel.Channel-java.lang.Throwable-"><code>channelOpenFailure(Channel, Throwable)</code></a> will be called</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>channel</code> - The initialized <a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel"><code>Channel</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="channelOpenSuccess-org.apache.sshd.common.channel.Channel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>channelOpenSuccess</h4> |
| <pre>void channelOpenSuccess(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel)</pre> |
| <div class="block">Called to inform about a channel being successfully opened for a |
| session. <B>Note:</B> when the call is made, the channel is known |
| to be open but nothing beyond that.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>channel</code> - The newly opened <a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel"><code>Channel</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="channelOpenFailure-org.apache.sshd.common.channel.Channel-java.lang.Throwable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>channelOpenFailure</h4> |
| <pre>void channelOpenFailure(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> reason)</pre> |
| <div class="block">Called to inform about the failure to open a channel</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>channel</code> - The failed <a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel"><code>Channel</code></a></dd> |
| <dd><code>reason</code> - The <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang"><code>Throwable</code></a> reason - <B>Note:</B> if the |
| <a href="../../../../../org/apache/sshd/common/channel/ChannelListener.html#channelOpenSuccess-org.apache.sshd.common.channel.Channel-"><code>channelOpenSuccess(Channel)</code></a> notification throws an exception |
| it will cause this method to be invoked</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="channelClosed-org.apache.sshd.common.channel.Channel-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>channelClosed</h4> |
| <pre>void channelClosed(<a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a> channel)</pre> |
| <div class="block">Called to inform about a channel being closed. <B>Note:</B> when the call |
| is made there are no guarantees about the channel's actual state |
| except that it either has been already closed or may be in the process |
| of being closed. <B>Note:</B> this method is guaranteed to be called |
| regardless of whether <a href="../../../../../org/apache/sshd/common/channel/ChannelListener.html#channelOpenSuccess-org.apache.sshd.common.channel.Channel-"><code>channelOpenSuccess(Channel)</code></a> or |
| <a href="../../../../../org/apache/sshd/common/channel/ChannelListener.html#channelOpenFailure-org.apache.sshd.common.channel.Channel-java.lang.Throwable-"><code>channelOpenFailure(Channel, Throwable)</code></a> have been called</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>channel</code> - The referenced <a href="../../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel"><code>Channel</code></a></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/ChannelListener.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/channel/ChannelFactory.html" title="interface in org.apache.sshd.common.channel"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/sshd/common/channel/ChannelListenerManager.html" title="interface in org.apache.sshd.common.channel"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/sshd/common/channel/ChannelListener.html" target="_top">Frames</a></li> |
| <li><a href="ChannelListener.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> |
