Add isComplete callback to commitEntry

[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 3212078c6bc2655ba4382d09f5c9c0231a3c6f1a..3b9e7752b9a80e5032055b5c3728709b437f3a13 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
@@ -9,6 +9,7 @@ package org.opendaylight.openflowjava.protocol.api.connection;
 
 import com.google.common.annotations.Beta;
 import com.google.common.util.concurrent.FutureCallback;
+import java.util.function.Function;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
@@ -44,5 +45,38 @@ public interface OutboundQueue {
      * @param callback Callback to be invoked, or null if no callback should be invoked.
      * @throws IllegalArgumentException if the slot is already committed or was never reserved.
      */
-    void commitEntry(@Nonnull Long xid, @Nullable OfHeader message, @Nullable FutureCallback<OfHeader> callback);
+    void commitEntry(
+            @Nonnull Long xid,
+            @Nullable OfHeader message,
+            @Nullable FutureCallback<OfHeader> callback);
+
+    /**
+     * Commit the specified offset using a message. Specified callback will
+     * be invoked once we know how it has resolved, either with a normal response,
+     * implied completion via a barrier, or failure (such as connection drop). For
+     * multipart responses, {@link FutureCallback#onSuccess(Object)} will be invoked
+     * multiple times as the corresponding responses arrive. If the request is completed
+     * with a response, the object reported will be non-null. If the request's completion
+     * is implied by a barrier, the object reported will be null.
+     *
+     * 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.
+     * @param callback Callback to be invoked, or null if no callback should be invoked.
+     * @param isComplete Function to determine if OfHeader is processing is complete
+     * @throws IllegalArgumentException if the slot is already committed or was never reserved.
+     */
+    void commitEntry(
+            @Nonnull Long xid,
+            @Nullable OfHeader message,
+            @Nullable FutureCallback<OfHeader> callback,
+            @Nullable Function<OfHeader, Boolean> isComplete);
 }