org.opendaylight.controller.cluster.access.client

Class ClientActorContext

java.lang.Object

org.opendaylight.controller.cluster.access.client.ClientActorContext

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.controller.cluster.access.concepts.ClientIdentifier>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

@Beta
 @ThreadSafe
public class ClientActorContext
extends Object
implements org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.controller.cluster.access.concepts.ClientIdentifier>

An actor context associated with this AbstractClientActor.

Time-keeping in a client actor is based on monotonic time. The precision of this time can be expected to be the same as System.nanoTime(), but it is not tied to that particular clock. Actor clock is exposed as a Ticker, which can be obtained via ticker().

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
ClientActorConfig	config()
org.opendaylight.controller.cluster.common.actor.Dispatchers	dispatchers()
<T extends BackendInfo> void	executeInActor(InternalCommand<T> command) Execute a command in the context of the client actor.
<T extends BackendInfo> akka.actor.Cancellable	executeInActor(InternalCommand<T> command, scala.concurrent.duration.FiniteDuration delay)
org.opendaylight.controller.cluster.access.concepts.ClientIdentifier	getIdentifier()
org.opendaylight.controller.cluster.messaging.MessageSlicer	messageSlicer()
akka.actor.ActorRef	self()
com.google.common.base.Ticker	ticker() Return the time ticker for this ClientActorContext.

Methods inherited from class java.lang.Object

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

Method Detail

getIdentifier

@Nonnull
public org.opendaylight.controller.cluster.access.concepts.ClientIdentifier getIdentifier()

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<org.opendaylight.controller.cluster.access.concepts.ClientIdentifier>

config

@Nonnull
public ClientActorConfig config()

dispatchers

@Nonnull
public org.opendaylight.controller.cluster.common.actor.Dispatchers dispatchers()

messageSlicer

@Nonnull
public org.opendaylight.controller.cluster.messaging.MessageSlicer messageSlicer()

ticker

@Nonnull
public com.google.common.base.Ticker ticker()

Return the time ticker for this ClientActorContext. This should be used for in all time-tracking done within a client actor. Subclasses of ClientActorBehavior are encouraged to use Stopwatch.

Returns:

Client actor time source

executeInActor

public <T extends BackendInfo> void executeInActor(@Nonnull
                                                   InternalCommand<T> command)

Execute a command in the context of the client actor.

Type Parameters:

T - BackendInfo type

Parameters:

command - Block of code which needs to be execute

executeInActor

public <T extends BackendInfo> akka.actor.Cancellable executeInActor(@Nonnull
                                                                     InternalCommand<T> command,
                                                                     scala.concurrent.duration.FiniteDuration delay)

self

@Nonnull
public final akka.actor.ActorRef self()