Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CompleteLease

Package version

Describes a Complete Lease.

class

CompleteLease.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

epoch

epoch: number
property

{number} epoch The epoch(time) of the lease, which is a value you can use to determine the most recent owner of a partition between competing nodes.

isOwned

isOwned: boolean = false
property

{boolean} isOwned Indicates wether the lease is owned. true if it is owned by someone; false otherwise.

owner

owner: string
property

{string} owner The host owner for the partition.

partitionId

partitionId: string
property

{string} partitionId The associated partitionId for which the lease is held.

readonly

Methods

getInfo

incrementEpoch

  • incrementEpoch(): number

  • Increments the value of epoch by 1.

    Returns number

    The incremented value of the epoch.

isOwnedBy

  • isOwnedBy(possibleOwner: string): boolean

  • Compares possibleOwner against this.owner

    Parameters

    • possibleOwner: string

      The owner name to check.

    Returns boolean

    boolean - true if possibleOwner is the same as this.owner, false otherwise.

Generated using TypeDoc