org.opendaylight.vtn.manager.internal.flow.remove

Class FlowRemoverQueue

java.lang.Object

org.opendaylight.vtn.manager.internal.flow.remove.FlowRemoverQueue

All Implemented Interfaces:

TxHook

public final class FlowRemoverQueue
extends Object
implements TxHook

FlowRemoverQueue describes a queue for FlowRemover instances that remove the specified flow entries.

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	enqueue(FlowRemover remover) Enqueue the given FlowRemover instance.
int	getOrder() Return an integer that determines the order of execution.
Collection<FlowRemover>	getRequests() Return an unmodifiable collection that contains flow removers 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

FlowRemoverQueue

public FlowRemoverQueue(TxContext ctx)

Construct a new instance.

Parameters:

ctx - A runtime context for transaction task.

Method Detail

enqueue

public void enqueue(FlowRemover remover)

Enqueue the given FlowRemover instance.

Parameters:

remover - A FlowRemover instance that specifies flow entries to be removed.

getRequests

public Collection<FlowRemover> getRequests()

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

Returns:

An unmodifiable collection of FlowRemover instances.

run

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

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

This method removes all the flow entries specified by the queued FlowRemover instances.

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.