org.opendaylight.vtn.manager.internal.flow.add

Class FlowAddQueue

java.lang.Object

org.opendaylight.vtn.manager.internal.flow.add.FlowAddQueue

All Implemented Interfaces:

TxHook

public final class FlowAddQueue
extends Object
implements TxHook

FlowAddQueue describes a queue for flow entries to be installed.

An instance of this class must be obtained by TxContext.getSpecific(Class). All the queued flow entries are installed asynchronously just after the successful completion of the MD-SAL datastore transaction associated with this instance. Note that requests will be discarded when the transaction is canceled.

Constructor Summary

Constructors

Constructor and Description
FlowAddQueue(TxContext ctx) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	enqueue(VTNFlowBuilder builder) Enqueue the given data flow to the request queue.
int	getOrder() Return an integer that determines the order of execution.
Collection<VTNFlowBuilder>	getRequests() Return an unmodifiable collection that contains flow entries in the queue.
void	run(TxContext ctx, TxTask<?> task) Invoked when the MD-SAL datastore transaction has been submitted successfully.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlowAddQueue

public FlowAddQueue(TxContext ctx)

Construct a new instance.

Parameters:

ctx - A runtime context for transaction task.

Method Detail

enqueue

public void enqueue(VTNFlowBuilder builder)

Enqueue the given data flow to the request queue.

Parameters:

builder - A VTNFlowBuilder instance that contains data flow to be installed.

getRequests

public Collection<VTNFlowBuilder> getRequests()

Return an unmodifiable collection that contains flow entries in the queue.

Returns:

An unmodifiable collection of VTNFlowBuilder instances.

run

public void run(TxContext ctx,
                TxTask<?> task)

Invoked when the MD-SAL datastore transaction has been submitted successfully.

This method installs all the flow entries in the request queue.

Specified by:

run in interface TxHook

Parameters:

ctx - A runtime context for transaction task.

task - The current transaction task.

getOrder

public int getOrder()

Return an integer that determines the order of execution.

Registered hooks are executed in ascending order of order values.

Specified by:

getOrder in interface TxHook

Returns:

An integer that determines the order of execution.