diff options
Diffstat (limited to 'src/main/java/ch/ethz/ssh2/ConnectionMonitor.java')
| -rw-r--r-- | src/main/java/ch/ethz/ssh2/ConnectionMonitor.java | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/src/main/java/ch/ethz/ssh2/ConnectionMonitor.java b/src/main/java/ch/ethz/ssh2/ConnectionMonitor.java new file mode 100644 index 0000000..06d3c3f --- /dev/null +++ b/src/main/java/ch/ethz/ssh2/ConnectionMonitor.java @@ -0,0 +1,37 @@ +/* + * Copyright (c) 2006-2011 Christian Plattner. All rights reserved. + * Please refer to the LICENSE.txt for licensing details. + */ +package ch.ethz.ssh2; + +/** + * A <code>ConnectionMonitor</code> is used to get notified when the + * underlying socket of a connection is closed. + * + * @author Christian Plattner + * @version 2.50, 03/15/10 + */ + +public interface ConnectionMonitor +{ + /** + * This method is called after the connection's underlying + * socket has been closed. E.g., due to the {@link Connection#close()} request of the + * user, if the peer closed the connection, due to a fatal error during connect() + * (also if the socket cannot be established) or if a fatal error occured on + * an established connection. + * <p> + * This is an experimental feature. + * <p> + * You MUST NOT make any assumption about the thread that invokes this method. + * <p> + * <b>Please note: if the connection is not connected (e.g., there was no successful + * connect() call), then the invocation of {@link Connection#close()} will NOT trigger + * this method.</b> + * + * @see Connection#addConnectionMonitor(ConnectionMonitor) + * + * @param reason Includes an indication why the socket was closed. + */ + public void connectionLost(Throwable reason); +}
\ No newline at end of file |