Class

akka.coordination.lease.scaladsl

Lease

Related Doc: package scaladsl

Permalink

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)

    Permalink

Abstract Value Members

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

    Permalink

    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]

    Permalink

    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

    Permalink

    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]

    Permalink

    Release the lease so some other owner can acquire it.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

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

  4. def ->[B](y: B): (Lease, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Lease to ArrowAssoc[Lease] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (Lease) ⇒ Boolean, msg: ⇒ Any): Lease

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

  9. def ensuring(cond: (Lease) ⇒ Boolean): Lease

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

  10. def ensuring(cond: Boolean, msg: ⇒ Any): Lease

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

  11. def ensuring(cond: Boolean): Lease

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

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Lease to StringFormat[Lease] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. val settings: LeaseSettings

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. def →[B](y: B): (Lease, B)

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped