org.opendaylight.ocpjava.protocol.api.connection

Interface OutboundQueue

@Beta
public interface OutboundQueue

Method Summary

Modifier and Type	Method and Description
void	commitEntry(Long xid, OcpHeader message, com.google.common.util.concurrent.FutureCallback<OcpHeader> callback) Commit the specified offset using a message.
Long	reserveEntry() Reserve an entry in the outbound queue.

Method Detail

reserveEntry

Long reserveEntry()

Reserve an entry in the outbound queue.

Returns:

XID for the new message, or null if the queue is full

commitEntry

void commitEntry(@Nonnull
                 Long xid,
                 @Nullable
                 OcpHeader message,
                 @Nullable
                 com.google.common.util.concurrent.FutureCallback<OcpHeader> 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, 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, 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.

Parameters:

xid - Previously-reserved XID

message - Message which should be sent out, or null if the reservation should be cancelled.

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.