Reduce NETCONF device disconnect warnings

[netconf.git] / netconf / netconf-api / src / main / java / org / opendaylight / netconf / api / NetconfSessionListener.java

diff --git a/netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/NetconfSessionListener.java b/netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/NetconfSessionListener.java
index 6f64fc5b73c4caf828db91922823a4caf558f972..9574c47df5bb50c0f6a7758297f7fa90d5a872cf 100644 (file)
--- a/netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/NetconfSessionListener.java
+++ b/netconf/netconf-api/src/main/java/org/opendaylight/netconf/api/NetconfSessionListener.java
@@ -7,6 +7,8 @@
  */
 package org.opendaylight.netconf.api;
 
+import java.io.EOFException;
+
 // FIXME: NETCONF-554: rework this interface
 public interface NetconfSessionListener<S extends NetconfSession> {
     /**
@@ -21,7 +23,8 @@ public interface NetconfSessionListener<S extends NetconfSession> {
      * session.
      *
      * @param session that went down
-     * @param cause Exception that was thrown as the cause of session being down
+     * @param cause Exception that was thrown as the cause of session being down. A common cause is
+     *              {@link EOFException}, which indicates the remote end has shut down the communication channel.
      */
     void onSessionDown(S session, Exception cause);