ClusterSingletonProxy

The ClusterSingletonProxy works together with the akka.cluster.singleton.ClusterSingletonManager to provide a distributed proxy to the singleton actor.

The proxy can be started on every node where the singleton needs to be reached and used as if it were the singleton itself. It will then act as a router to the currently running singleton instance. If the singleton is not currently available, e.g., during hand off or startup, the proxy will buffer the messages sent to the singleton and then deliver them when the singleton is finally available. The size of the buffer is configurable and it can be disabled by using a buffer size of 0. When the buffer is full old messages will be dropped when new messages are sent via the proxy.

The proxy works by keeping track of the oldest cluster member. When a new oldest member is identified, e.g. because the older one left the cluster, or at startup, the proxy will try to identify the singleton on the oldest member by periodically sending an akka.actor.Identify message until the singleton responds with its akka.actor.ActorIdentity.

Note that this is a best effort implementation: messages can always be lost due to the distributed nature of the actors involved.

Source: ClusterSingletonProxy.scala

Linear Supertypes

ActorLogging, Actor, AnyRef, Any

Type Hierarchy

Instance Constructors

new ClusterSingletonProxy(singletonManagerPath: String, settings: ClusterSingletonProxySettings)

Type Members

type Receive = PartialFunction[Any, Unit]

Definition Classes
Actor

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from ClusterSingletonProxy to any2stringadd[ClusterSingletonProxy] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (ClusterSingletonProxy, B)

Implicit information
This member is added by an implicit conversion from ClusterSingletonProxy to ArrowAssoc[ClusterSingletonProxy] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def add(m: Member): Unit

Adds new member if it has the right role.
Adds new member if it has the right role.
m
New cluster member.
val ageOrdering: Ordering[Member]
def aroundPostRestart(reason: Throwable): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundPostStop(): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundPreStart(): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

Attributes
protected[akka]
Definition Classes
Actor
Annotations
@InternalApi()
final def asInstanceOf[T0]: T0

Definition Classes
Any
def buffer(msg: Any): Unit
var buffer: MessageBuffer
def cancelTimer(): Unit
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val cluster: Cluster
implicit val context: ActorContext

Definition Classes
Actor
def createIdentifyId(i: Int): String
def ensuring(cond: (ClusterSingletonProxy) ⇒ Boolean, msg: ⇒ Any): ClusterSingletonProxy

Implicit information
This member is added by an implicit conversion from ClusterSingletonProxy to Ensuring[ClusterSingletonProxy] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ClusterSingletonProxy) ⇒ Boolean): ClusterSingletonProxy

Implicit information
This member is added by an implicit conversion from ClusterSingletonProxy to Ensuring[ClusterSingletonProxy] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): ClusterSingletonProxy

Implicit information
This member is added by an implicit conversion from ClusterSingletonProxy to Ensuring[ClusterSingletonProxy] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ClusterSingletonProxy

Implicit information
This member is added by an implicit conversion from ClusterSingletonProxy to Ensuring[ClusterSingletonProxy] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from ClusterSingletonProxy to StringFormat[ClusterSingletonProxy] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def handleInitial(state: CurrentClusterState): Unit
def hashCode(): Int

Definition Classes
AnyRef → Any
var identifyCounter: Int
var identifyId: String
def identifySingleton(): Unit

Discard old singleton ActorRef and send a periodic message to self to identify the singleton.
var identifyTimer: Option[Cancellable]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def log: LoggingAdapter

Definition Classes
ActorLogging
def matchingRole(member: Member): Boolean
var membersByAge: SortedSet[Member]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def postRestart(reason: Throwable): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def postStop(): Unit

Definition Classes
ClusterSingletonProxy → Actor
def preRestart(reason: Throwable, message: Option[Any]): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def preStart(): Unit

Definition Classes
ClusterSingletonProxy → Actor
def receive: PartialFunction[Any, Unit]

Definition Classes
ClusterSingletonProxy → Actor
def remove(m: Member): Unit

Removes a member.
Removes a member.
m
Cluster member to remove.
implicit final val self: ActorRef

Definition Classes
Actor
def sendBuffered(): Unit
final def sender(): ActorRef

Definition Classes
Actor
var singleton: Option[ActorRef]
val singletonPath: Array[String]
def supervisorStrategy: SupervisorStrategy

Definition Classes
Actor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def trackChange(block: () ⇒ Unit): Unit
def unhandled(message: Any): Unit

Definition Classes
Actor
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def →[B](y: B): (ClusterSingletonProxy, B)

Implicit information
This member is added by an implicit conversion from ClusterSingletonProxy to ArrowAssoc[ClusterSingletonProxy] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Related Docs: object ClusterSingletonProxy | package singleton

final class ClusterSingletonProxy extends Actor with ActorLogging

Instance Constructors

new ClusterSingletonProxy(singletonManagerPath: String, settings: ClusterSingletonProxySettings)

Type Members

type Receive = PartialFunction[Any, Unit]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (ClusterSingletonProxy, B)

final def ==(arg0: Any): Boolean

def add(m: Member): Unit

val ageOrdering: Ordering[Member]

def aroundPostRestart(reason: Throwable): Unit

def aroundPostStop(): Unit

def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

def aroundPreStart(): Unit

def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

def buffer(msg: Any): Unit

var buffer: MessageBuffer

def cancelTimer(): Unit

def clone(): AnyRef

val cluster: Cluster

implicit val context: ActorContext

def createIdentifyId(i: Int): String

def ensuring(cond: (ClusterSingletonProxy) ⇒ Boolean, msg: ⇒ Any): ClusterSingletonProxy

def ensuring(cond: (ClusterSingletonProxy) ⇒ Boolean): ClusterSingletonProxy

def ensuring(cond: Boolean, msg: ⇒ Any): ClusterSingletonProxy

def ensuring(cond: Boolean): ClusterSingletonProxy

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatted(fmtstr: String): String

final def getClass(): Class[_]

def handleInitial(state: CurrentClusterState): Unit

def hashCode(): Int

var identifyCounter: Int

var identifyId: String

def identifySingleton(): Unit

var identifyTimer: Option[Cancellable]

final def isInstanceOf[T0]: Boolean

def log: LoggingAdapter

def matchingRole(member: Member): Boolean

var membersByAge: SortedSet[Member]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def postRestart(reason: Throwable): Unit

def postStop(): Unit

def preRestart(reason: Throwable, message: Option[Any]): Unit

def preStart(): Unit

def receive: PartialFunction[Any, Unit]

def remove(m: Member): Unit

implicit final val self: ActorRef

def sendBuffered(): Unit

final def sender(): ActorRef

var singleton: Option[ActorRef]

val singletonPath: Array[String]

def supervisorStrategy: SupervisorStrategy

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def trackChange(block: () ⇒ Unit): Unit

def unhandled(message: Any): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def →[B](y: B): (ClusterSingletonProxy, B)

Inherited from ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterSingletonProxy to any2stringadd[ClusterSingletonProxy]

Inherited by implicit conversion StringFormat from ClusterSingletonProxy to StringFormat[ClusterSingletonProxy]

Inherited by implicit conversion Ensuring from ClusterSingletonProxy to Ensuring[ClusterSingletonProxy]

Inherited by implicit conversion ArrowAssoc from ClusterSingletonProxy to ArrowAssoc[ClusterSingletonProxy]

Ungrouped