org.opendaylight.vtn.manager.internal.flow.common

Class FlowModContext<T,D>

java.lang.Object

org.opendaylight.vtn.manager.internal.flow.common.FlowModContext<T,D>

Type Parameters:

T - The type of the value to be returned by the future associated with the task.

D - The type of the value to be returned by the MD-SAL DS transaction task.

Direct Known Subclasses:

FlowAddContext, FlowRemoveContext

public abstract class FlowModContext<T,D>
extends Object

Describes runtime information for modifying VTN data flows.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FlowModContext(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService sfs, VTNThreadPool thread) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VTNFuture<T>	getContextFuture() Return the future associated with this context.
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService	getFlowService() Return the MD-SAL flow service.
VTNThreadPool	getFlowThread() Return the thread used to run tasks for modifying flow entries.
abstract TxTask<D>	newDatastoreTask(TxQueue txq) Create a new MD-SAL DS task that modifies VTN data flows.
void	setFailure(Throwable cause) Set the cause of the failure of the flow modification.
void	setResult(T result) Set the result of the flow modification.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowModContext

protected FlowModContext(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService sfs,
                         VTNThreadPool thread)

Construct a new instance.

Parameters:

sfs - The MD-SAL flow service.

thread - A thread pool to run tasks for modifying flow entries.

Method Detail

getFlowService

public final org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowService getFlowService()

Return the MD-SAL flow service.

Returns:

A SalFlowService instance. Note that null is returned if the flow service is already closed.

getFlowThread

public final VTNThreadPool getFlowThread()

Return the thread used to run tasks for modifying flow entries.

Returns:

A VTNThreadPool instance.

getContextFuture

public final VTNFuture<T> getContextFuture()

Return the future associated with this context.

Returns:

A VTNFuture instance associated with this context.

setResult

public final void setResult(T result)

Set the result of the flow modification.

Parameters:

result - The result of the flow modification.

setFailure

public final void setFailure(Throwable cause)

Set the cause of the failure of the flow modification.

Parameters:

cause - A Throwable that indicates the cause of failure.

newDatastoreTask

public abstract TxTask<D> newDatastoreTask(TxQueue txq)

Create a new MD-SAL DS task that modifies VTN data flows.

Parameters:

txq - A MD-SAL DS transaction queue.

Returns:

A TxTask instance associated with the new MD-SAL DS task.