comparison src/ch/ethz/ssh2/ConnectionMonitor.java @ 308:42b15aaa7ac7 ganymed

merge
author Carl Byington <carl@five-ten-sg.com>
date Wed, 30 Jul 2014 14:21:50 -0700
parents 071eccdff8ea
children
comparison
equal deleted inserted replaced
306:90e47d99ea54 308:42b15aaa7ac7
4 */ 4 */
5 package ch.ethz.ssh2; 5 package ch.ethz.ssh2;
6 6
7 /** 7 /**
8 * A <code>ConnectionMonitor</code> is used to get notified when the 8 * A <code>ConnectionMonitor</code> is used to get notified when the
9 * underlying socket of a connection is closed. 9 * underlying socket of a connection is closed.
10 * 10 *
11 * @author Christian Plattner 11 * @author Christian Plattner
12 * @version 2.50, 03/15/10 12 * @version 2.50, 03/15/10
13 */ 13 */
14 14
15 public interface ConnectionMonitor 15 public interface ConnectionMonitor {
16 { 16 /**
17 /** 17 * This method is called after the connection's underlying
18 * This method is called after the connection's underlying 18 * socket has been closed. E.g., due to the {@link Connection#close()} request of the
19 * socket has been closed. E.g., due to the {@link Connection#close()} request of the 19 * user, if the peer closed the connection, due to a fatal error during connect()
20 * user, if the peer closed the connection, due to a fatal error during connect() 20 * (also if the socket cannot be established) or if a fatal error occured on
21 * (also if the socket cannot be established) or if a fatal error occured on 21 * an established connection.
22 * an established connection. 22 * <p>
23 * <p> 23 * This is an experimental feature.
24 * This is an experimental feature. 24 * <p>
25 * <p> 25 * You MUST NOT make any assumption about the thread that invokes this method.
26 * You MUST NOT make any assumption about the thread that invokes this method. 26 * <p>
27 * <p> 27 * <b>Please note: if the connection is not connected (e.g., there was no successful
28 * <b>Please note: if the connection is not connected (e.g., there was no successful 28 * connect() call), then the invocation of {@link Connection#close()} will NOT trigger
29 * connect() call), then the invocation of {@link Connection#close()} will NOT trigger 29 * this method.</b>
30 * this method.</b> 30 *
31 * 31 * @see Connection#addConnectionMonitor(ConnectionMonitor)
32 * @see Connection#addConnectionMonitor(ConnectionMonitor) 32 *
33 * 33 * @param reason Includes an indication why the socket was closed.
34 * @param reason Includes an indication why the socket was closed. 34 */
35 */ 35 public void connectionLost(Throwable reason);
36 public void connectionLost(Throwable reason);
37 } 36 }