org.opendaylight.openflowjava.protocol.api.connection

Interface OutboundQueueHandler

All Known Subinterfaces:

OutboundQueueProvider

All Known Implementing Classes:

OutboundQueueProviderImpl

@Beta
public interface OutboundQueueHandler

Handler of the outbound queue. The queue has a maximum depth assigned when the handler is registered.

Method Summary

Modifier and Type	Method and Description
BarrierInput	createBarrierRequest(Long xid) Create a new barrier message.
void	onConnectionQueueChanged(OutboundQueue queue) Invoked whenever the underlying queue is refreshed.

Method Detail

createBarrierRequest

@Nonnull
BarrierInput createBarrierRequest(@Nonnull
                                           Long xid)

Create a new barrier message. This callback is invoked when the queue is being flushed to the switch. The barrier ensures that any outstanding requests are detected as either completed or failed.

Parameters:

xid - XID for the barrier message

Returns:

New barrier message.

onConnectionQueueChanged

void onConnectionQueueChanged(OutboundQueue queue)

Invoked whenever the underlying queue is refreshed. Implementations should ensure they are talking to the latest queue

Parameters:

queue - New queue instance, null indicates a shutdown, e.g. the queue is no longer available.