Packages

abstract class Lease extends AnyRef

Annotations
@ApiMayChange()
Source
Lease.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Lease
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Lease(settings: LeaseSettings)

Abstract Value Members

  1. abstract def acquire(leaseLostCallback: (Option[Throwable]) ⇒ Unit): Future[Boolean]

    Same as acquire with an additional callback that is called if the lease is lost.

    Same as acquire with an additional callback that is called if the lease is lost. The lease can be lose due to being unable to communicate with the lease provider. Implementations should not call leaseLostCallback until after the returned future has been completed

  2. abstract def acquire(): Future[Boolean]

    Try to acquire the lease.

    Try to acquire the lease. The returned Future will be completed with true if the lease could be acquired, i.e. no other owner is holding the lease.

    The returned Future will be completed with false if the lease for certain couldn't be acquired, e.g. because some other owner is holding it. It's completed with akka.coordination.lease.LeaseException failure if it might not have been able to acquire the lease, e.g. communication timeout with the lease resource.

    The lease will be held by the akka.coordination.lease.LeaseSettings.ownerName until it is released with Lease.release. A Lease implementation will typically also lose the ownership if it can't maintain its authority, e.g. if it crashes or is partitioned from the lease resource for too long.

    Lease.checkLease can be used to verify that the owner still has the lease.

  3. abstract def checkLease(): Boolean

    Check if the owner still holds the lease.

    Check if the owner still holds the lease. true means that it certainly holds the lease. false means that it might not hold the lease, but it could, and for more certain response you would have to use Lease#acquire()* or Lease#release.

  4. abstract def release(): Future[Boolean]

    Release the lease so some other owner can acquire it.

Concrete Value Members

  1. val settings: LeaseSettings