FailureDetectorRegistry

Interface for a registry of Akka failure detectors. New resources are implicitly registered when heartbeat is first called with the resource given as parameter.

type parameter A:

  • The type of the key that identifies a resource to be monitored by a failure detector
Source:
FailureDetectorRegistry.scala
class Object
trait Matchable
class Any

Value members

Abstract methods

def heartbeat(resource: A): Unit

Records a heartbeat for a resource. If the resource is not yet registered (i.e. this is the first heartbeat) then it is automatically registered.

Records a heartbeat for a resource. If the resource is not yet registered (i.e. this is the first heartbeat) then it is automatically registered.

Source:
FailureDetectorRegistry.scala
def isAvailable(resource: A): Boolean

Returns true if the resource is considered to be up and healthy and returns false otherwise. For unregistered resources it returns true.

Returns true if the resource is considered to be up and healthy and returns false otherwise. For unregistered resources it returns true.

Source:
FailureDetectorRegistry.scala
def isMonitoring(resource: A): Boolean

Returns true if the failure detector has received any heartbeats and started monitoring of the resource.

Returns true if the failure detector has received any heartbeats and started monitoring of the resource.

Source:
FailureDetectorRegistry.scala
def remove(resource: A): Unit

Removes the heartbeat management for a resource.

Removes the heartbeat management for a resource.

Source:
FailureDetectorRegistry.scala
def reset(): Unit

Removes all resources and any associated failure detector state.

Removes all resources and any associated failure detector state.

Source:
FailureDetectorRegistry.scala