Class LeaseHolder

A representation of a leaseholder who is identified by a username, hostname, and process id (PID). This implementation is serializable to/from a JSON object and is comparable to other leaseholders.

Index

Accessors

hostname processId username

Methods

equals isProcessAlive isSameMachineIdentity toJson toObject default fromJson of

Accessors

hostname

get hostname(): string
The machine's identity which is typically the hostname.

Returns string
the machine's identity.
- Defined in solo/solo/src/core/lease/lease_holder.ts:85

processId

get processId(): number
The process identifier which is typically the OS PID.

Returns number
the process identifier.
- Defined in solo/solo/src/core/lease/lease_holder.ts:93

username

get username(): string
The user's identity which is typically the OS login username.

Returns string
the user's identity.
- Defined in solo/solo/src/core/lease/lease_holder.ts:77

Methods

equals

equals(other: LeaseHolder): boolean
Compares this leaseholder to another leaseholder to determine if they are equal. Two leaseholders are equal if their username, hostname, and process id are the same.
Parameters
- other: LeaseHolder
  the other leaseholder to compare.
Returns boolean
true if the leaseholders are equal; false otherwise.
- Defined in solo/solo/src/core/lease/lease_holder.ts:115

isProcessAlive

isProcessAlive(): boolean
Determines if the process associated with this leaseholder is still alive. This method will return false if the process is not alive or an error occurs while checking the process status.

Returns boolean
true if the process is alive; false otherwise.
- Defined in solo/solo/src/core/lease/lease_holder.ts:134

isSameMachineIdentity

isSameMachineIdentity(other: LeaseHolder): boolean
Compares this leaseholder to another leaseholder to determine if they are the same machine. Two leaseholders are the same machine if their username and hostname are the same.
Parameters
- other: LeaseHolder
  the other leaseholder to compare.
Returns boolean
true if the leaseholders are the same machine; false otherwise.
- Defined in solo/solo/src/core/lease/lease_holder.ts:125

toJson

toJson(): string
Serializes this leaseholder to a JSON string representation.

Returns string
a JSON string representation of this leaseholder.
- Defined in solo/solo/src/core/lease/lease_holder.ts:146

toObject

toObject(): any
Returns a plain object representation of this leaseholder. This object may be serialized to JSON.

Returns any
a plain object representation of this leaseholder.
- Defined in solo/solo/src/core/lease/lease_holder.ts:101

`Static`default

default(): LeaseHolder
Creates a new leaseholder by retrieving the current user's identity, the current machine's hostname, and the current process's PID.

Returns LeaseHolder
a new leaseholder instance.
- Defined in solo/solo/src/core/lease/lease_holder.ts:69

`Static`fromJson

fromJson(json: string): LeaseHolder
Deserializes a JSON string representation of a leaseholder into a new leaseholder instance.
Parameters
- json: string
  the JSON string representation of a leaseholder.
Returns LeaseHolder
a new leaseholder instance.
- Defined in solo/solo/src/core/lease/lease_holder.ts:155

`Static`of

of(username: string): LeaseHolder
Creates a new leaseholder with the given username. The hostname is set to the current machine's hostname and the process id is set to the current process's PID.
Parameters
- username: string
  the user's identity.
Returns LeaseHolder
a new leaseholder instance.
- Defined in solo/solo/src/core/lease/lease_holder.ts:60