Member
Defined in: src/cluster/Member.ts:16
Immutable description of a cluster member at a point in time. Member
instances are replaced (not mutated) as their status evolves. The
version counter is incremented on every status change and acts as a
logical clock for gossip merges.
removedAt is set only on tombstone members (status === ‘removed’),
via withRemoved. It carries the wall-clock instant at which
the tombstone was created and gossips to peers so every node prunes
the tombstone at roughly the same wall-clock time — see
Cluster.tombstonePruneTick (#75).
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Member(
address,status,version,roles?,removedAt?):Member
Defined in: src/cluster/Member.ts:19
Parameters
Section titled “Parameters”address
Section titled “address”status
Section titled “status”version
Section titled “version”number
roles?
Section titled “roles?”Iterable<string> = []
removedAt?
Section titled “removedAt?”number
Returns
Section titled “Returns”Member
Properties
Section titled “Properties”address
Section titled “address”
readonlyaddress:NodeAddress
Defined in: src/cluster/Member.ts:20
removedAt?
Section titled “removedAt?”
readonlyoptionalremovedAt?:number
Defined in: src/cluster/Member.ts:24
readonlyroles:ReadonlySet<string>
Defined in: src/cluster/Member.ts:17
status
Section titled “status”
readonlystatus:MemberStatus
Defined in: src/cluster/Member.ts:21
version
Section titled “version”
readonlyversion:number
Defined in: src/cluster/Member.ts:22
Methods
Section titled “Methods”hasRole()
Section titled “hasRole()”hasRole(
role):boolean
Defined in: src/cluster/Member.ts:29
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
isReachable()
Section titled “isReachable()”isReachable():
boolean
Defined in: src/cluster/Member.ts:31
Returns
Section titled “Returns”boolean
toData()
Section titled “toData()”toData():
MemberData
Defined in: src/cluster/Member.ts:38
Returns
Section titled “Returns”toString()
Section titled “toString()”toString():
string
Defined in: src/cluster/Member.ts:78
Returns
Section titled “Returns”string
withRemoved()
Section titled “withRemoved()”withRemoved(
removedAt):Member
Defined in: src/cluster/Member.ts:74
Transition into the removed tombstone state with a fresh
removedAt timestamp. Cluster paths that definitively remove a
peer (graceful leave, downing-provider force-down) call this
instead of withStatus('removed') so the tombstone carries an
age — required for Cluster.tombstonePruneTick to drop expired
tombstones cluster-wide (#75).
Parameters
Section titled “Parameters”removedAt
Section titled “removedAt”number
Returns
Section titled “Returns”Member
withStatus()
Section titled “withStatus()”withStatus(
status):Member
Defined in: src/cluster/Member.ts:62
Parameters
Section titled “Parameters”status
Section titled “status”Returns
Section titled “Returns”Member
fromData()
Section titled “fromData()”
staticfromData(data):Member
Defined in: src/cluster/Member.ts:52
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Member