org.opendaylight.openflowplugin.openflow.md.core.sal

Class OFRpcTask<T,K>

java.lang.Object

org.opendaylight.openflowplugin.openflow.md.core.sal.OFRpcTask<T,K>

Type Parameters:

T - input type

K - future output type

All Implemented Interfaces:

Callable<com.google.common.util.concurrent.ListenableFuture<K>>

public abstract class OFRpcTask<T,K>
extends Object
implements Callable<com.google.common.util.concurrent.ListenableFuture<K>>

Constructor Summary

Constructors

Constructor and Description
OFRpcTask(OFRpcTaskContext taskContext, SwitchConnectionDistinguisher cookie, T input)

Method Summary

Modifier and Type	Method and Description
SwitchConnectionDistinguisher	getCookie()
T	getInput()
long	getMaxTimeout()
TimeUnit	getMaxTimeoutUnit()
IMessageDispatchService	getMessageService()
org.opendaylight.controller.sal.binding.api.NotificationProviderService	getRpcNotificationProviderService()
SessionContext	getSession()
OFRpcTaskContext	getTaskContext()
Short	getVersion()
Boolean	isBarrier()
void	setCookie(SwitchConnectionDistinguisher cookie)
void	setInput(T input)
com.google.common.util.concurrent.ListenableFuture<K>	submit() submit task into rpc worker pool

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Callable

call

Constructor Detail

OFRpcTask

public OFRpcTask(OFRpcTaskContext taskContext,
                 SwitchConnectionDistinguisher cookie,
                 T input)

Parameters:

taskContext - rpc task context

input - task input

cookie - switch connection distinguisher cookie value

Method Detail

getCookie

public SwitchConnectionDistinguisher getCookie()

Returns:

the cookie

setCookie

public void setCookie(SwitchConnectionDistinguisher cookie)

Parameters:

cookie - the cookie to set

getInput

public T getInput()

Returns:

the input

setInput

public void setInput(T input)

Parameters:

input - the input to set

getRpcNotificationProviderService

public org.opendaylight.controller.sal.binding.api.NotificationProviderService getRpcNotificationProviderService()

Returns:

the rpcNotificationProviderService

getMessageService

public IMessageDispatchService getMessageService()

Returns:

message service

See Also:

OFRpcTaskContext.getMessageService()

getSession

public SessionContext getSession()

Returns:

session

See Also:

OFRpcTaskContext.getSession()

getMaxTimeout

public long getMaxTimeout()

Returns:

max timeout

See Also:

OFRpcTaskContext.getMaxTimeout()

getMaxTimeoutUnit

public TimeUnit getMaxTimeoutUnit()

Returns:

time unit for max timeout

See Also:

OFRpcTaskContext.getMaxTimeoutUnit()

getVersion

public Short getVersion()

Returns:

protocol version

getTaskContext

public OFRpcTaskContext getTaskContext()

Returns:

the taskContext

submit

public com.google.common.util.concurrent.ListenableFuture<K> submit()

submit task into rpc worker pool

Returns:

future result of task

isBarrier

public Boolean isBarrier()

Returns:

required barrier value