BUG-3219: introduce OutboundQueueException

[openflowjava.git] / openflow-protocol-api / src / main / java / org / opendaylight / openflowjava / protocol / api / connection / OutboundQueue.java

diff --git a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/connection/OutboundQueue.java b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/connection/OutboundQueue.java
index 06b66c5e046f320537f8dcddefb42db981a10d86..afe5b056b2192cb183d5c4b6f7d9426b38c700a6 100644 (file)
--- a/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/connection/OutboundQueue.java
+++ b/openflow-protocol-api/src/main/java/org/opendaylight/openflowjava/protocol/api/connection/OutboundQueue.java
@@ -33,6 +33,11 @@ public interface OutboundQueue {
      * If this request fails on the remote device, {@link FutureCallback#onFailure(Throwable)
      * will be called with an instance of {@link DeviceRequestFailedException}.
      *
+     * If the request fails due to local reasons, {@link FutureCallback#onFailure(Throwable)
+     * will be called with an instance of {@link OutboundQueueException}. In particular, if
+     * this request failed because the device disconnected, {@link OutboundQueueException#DEVICE_DISCONNECTED}
+     * will be reported.
+     *
      * @param xid Previously-reserved XID
      * @param message Message which should be sent out, or null if the reservation
      *                should be cancelled.