diff options
| author | Kenny Root <kenny@the-b.org> | 2007-11-17 05:58:42 +0000 |
|---|---|---|
| committer | Kenny Root <kenny@the-b.org> | 2007-11-17 05:58:42 +0000 |
| commit | ad9b24675b3b582ea4e6bbe6ee1fce9dee37f1f3 (patch) | |
| tree | 80d86874422cec6f00afa34ed2c3acc0781243cf /lib/src/main/java/com/trilead/ssh2/ConnectionMonitor.java | |
| parent | edfccaafe3e754ed124afa67465b6044eacd3987 (diff) | |
| download | sshlib-ad9b24675b3b582ea4e6bbe6ee1fce9dee37f1f3.tar.gz sshlib-ad9b24675b3b582ea4e6bbe6ee1fce9dee37f1f3.tar.bz2 sshlib-ad9b24675b3b582ea4e6bbe6ee1fce9dee37f1f3.zip | |
Initial import.
Diffstat (limited to 'lib/src/main/java/com/trilead/ssh2/ConnectionMonitor.java')
| -rw-r--r-- | lib/src/main/java/com/trilead/ssh2/ConnectionMonitor.java | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/lib/src/main/java/com/trilead/ssh2/ConnectionMonitor.java b/lib/src/main/java/com/trilead/ssh2/ConnectionMonitor.java new file mode 100644 index 0000000..d378be5 --- /dev/null +++ b/lib/src/main/java/com/trilead/ssh2/ConnectionMonitor.java @@ -0,0 +1,34 @@ +
+package com.trilead.ssh2;
+
+/**
+ * A <code>ConnectionMonitor</code> is used to get notified when the
+ * underlying socket of a connection is closed.
+ *
+ * @author Christian Plattner, plattner@trilead.com
+ * @version $Id: ConnectionMonitor.java,v 1.1 2007/10/15 12:49:56 cplattne Exp $
+ */
+
+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 |