org.opendaylight.vtn.manager.internal

Interface TxTask<T>

Type Parameters:

T - The type of the object to be returned by the task.

All Known Implementing Classes:

AbstractDataTask, AbstractRpcTask, AbstractTxTask, AddedFlowStats, AddFlowStatsTask, AddVlanMapTask, ClearFlowConditionTask, ClearFlowFilterTask, ClearMacEntryTask, ClearPathMapTask, ClearPathPolicyTask, ClearVlanMapTask, CompositeTxTask, DeleteDataTask, DeleteFlowTxTask, DeleteVlanMapTask, FlowFilterTask, FlowMatchTask, PacketInEvent, PathCostTask, PathMapTask, PutDataTask, PutFlowTxTask, RemoveCostTask, RemoveFilterTask, RemoveFlowConditionTask, RemoveFlowFilterTask, RemoveFlowMatchTask, RemoveMacEntryTask, RemoveMacTask, RemoveMapTask, RemoveMatchTask, RemovePathCostTask, RemovePathMapTask, RemovePathPolicyTask, RemovePortMapTask, RemoveVbridgeTask, RemoveVinterfaceTask, RemoveVirtualNodeTask, RemoveVlanMapTask, RemoveVterminalTask, RemoveVtnTask, RollbackTxTask, RoutingEvent, SetCostTask, SetFilterTask, SetFlowConditionTask, SetFlowFilterTask, SetFlowMatchTask, SetMacMapAclTask, SetMacMapTask, SetMapTask, SetMatchTask, SetPathCostTask, SetPathMapTask, SetPathPolicyTask, SetPortMapTask, TxEvent, UpdateMacMapTask, UpdateVbridgeTask, UpdateVinterfaceTask, UpdateVirtualNodeTask, UpdateVterminalTask, UpdateVtnTask, VtnNodeEvent, VtnPortEvent

public interface TxTask<T>

The interface to be implemented by a task that modifies data tree in the MD-SAL datastore on TxQueue.

The MD-SAL transaction task may start some background tasks associated with VTNFuture instances.

See Also:

TxQueue

Method Summary

Modifier and Type	Method and Description
void	addBackgroundTask(VTNFuture<?> future) Associate the given future with this task.
T	execute(TxContext ctx, int attempts) Modify the MD-SAL datastore using the given transaction.
List<VTNFuture<?>>	getBackgroundTasks() Return an immutable list of VTNFuture instances associated with background tasks started by the MD-SAL transaction task.
default boolean	isAsync() Determine whether this instance is associated with an asynchronous task or not.
default boolean	needErrorLog(Throwable t) Determine whether the transaction queue should log the given error or not.
void	onFailure(VTNManagerProvider provider, Throwable t) Invoked when the task has failed.
void	onSuccess(VTNManagerProvider provider, T result) Invoked when the task has completed successfully.

Method Detail

execute

T execute(TxContext ctx,
          int attempts)
   throws VTNException

Modify the MD-SAL datastore using the given transaction.

Note that this method may be called more than once when a MD-SAL datastore transaction is aborted due to data conflict.

Parameters:

ctx - A runtime context for transaction task.

attempts - The number of calls of this method. 0 is passed for the first call.

Returns:

Result of this task.

Throws:

VTNException - An error occurred.

needErrorLog

default boolean needErrorLog(Throwable t)

Determine whether the transaction queue should log the given error or not.

By default, this method returns true.

Parameters:

t - A Throwable that is going to be thrown.

Returns:

true if an error should be logged. false if an error log is not required.

isAsync

default boolean isAsync()

Determine whether this instance is associated with an asynchronous task or not.

By default, this method returns false.

Returns:

true if this instance is associated with an asynchronous task. false otherwise.

onSuccess

void onSuccess(VTNManagerProvider provider,
               T result)

Invoked when the task has completed successfully.

Note that this method must be called prior to FutureCallback.

Parameters:

provider - VTN Manager provider service.

result - An object returned by execute(TxContext, int).

onFailure

void onFailure(VTNManagerProvider provider,
               Throwable t)

Invoked when the task has failed.

Note that this method must be called prior to FutureCallback.

Parameters:

provider - VTN Manager provider service.

t - A Throwable thrown by the task.

getBackgroundTasks

List<VTNFuture<?>> getBackgroundTasks()

Return an immutable list of VTNFuture instances associated with background tasks started by the MD-SAL transaction task.

Returns:

An immutable list of VTNFuture instances. An empty list is returned if no background task has started or this task does not complete yet. Note that this method must not return null.

addBackgroundTask

void addBackgroundTask(VTNFuture<?> future)

Associate the given future with this task.

The task associated with the given future will be treated as a background task associated with this task.

Parameters:

future - A VTNFuture instance associated with background task.