Class StateVector

SVS state vector.

Index

Constructors

constructor

new StateVector(from?: Record<string, number> | StateVector): StateVector
Constructor.
Parameters
- Optionalfrom: Record<string, number> | StateVector
  Copy from state vector or its JSON value.
Returns StateVector
- Defined in svs/src/state-vector.ts:37
new StateVector(from: NodeMap): StateVector
Internal
Parameters
- from: NodeMap
Returns StateVector
- Defined in svs/src/state-vector.ts:40

Accessors

maxBoot

get maxBoot(): number
Return maximum bootstrap timestamp.

Returns number
- Defined in svs/src/state-vector.ts:115

Methods

[iterator]

"[iterator]"(): IterableIterator<[id: Name & StateVector.ID, seqNum: number]>
Iterate over nodes and their sequence numbers.

Returns IterableIterator<[id: Name & StateVector.ID, seqNum: number]>
- Defined in svs/src/state-vector.ts:108

encodeTo

encodeTo(encoder: Encoder, version?: 2 | 3): void
Encode StateVector TLV.
Parameters
- encoder: Encoder
- version: 2 | 3 = 2
Returns void
- Defined in svs/src/state-vector.ts:158

get

get(id: Name | StateVector.ID): number
Get node sequence number.
Parameters
- id: Name | StateVector.ID
  Name (SVS v2) or Name+bootstrapTime (SVS v3).
Returns number
Remarks
If the node does not exist, returns zero.
- Defined in svs/src/state-vector.ts:73

getEntry

getEntry(id: Name | StateVector.ID): NodeEntry
Get node entry.
Parameters
- id: Name | StateVector.ID
  Name (SVS v2) or Name+bootstrapTime (SVS v3).
Returns NodeEntry
Remarks
If the node does not exist, returns an entry with seqNum=0.
- Defined in svs/src/state-vector.ts:84

listOlderThan

listOlderThan(other: StateVector): DiffEntry[]
List nodes with older sequence number in this state vector than other.
Parameters
- other: StateVector
Returns DiffEntry[]
- Defined in svs/src/state-vector.ts:137

mergeFrom

mergeFrom(other: StateVector, lastUpdate?: number): void
Update this state vector to have newer sequence numbers between this and other.
Parameters
- other: StateVector
- lastUpdate: number = ...
Returns void
- Defined in svs/src/state-vector.ts:142

set

set(id: Name | StateVector.ID, entry: number | NodeEntry): void
Set node sequence number or entry.
Parameters
- id: Name | StateVector.ID
  Name (SVS v2) or Name+bootstrapTime (SVS v3).
- entry: number | NodeEntry
  If specified as number, it's interpreted as sequence number, and performance.now() is used as lastUpdate. Otherwise, it's used as the node entry.
Returns void
Remarks
Setting sequence number to zero removes the node.
- Defined in svs/src/state-vector.ts:98

toJSON

toJSON(): Record<string, number>
Serialize as JSON.

Returns Record<string, number>
- Defined in svs/src/state-vector.ts:149

`Static`decodeFrom

decodeFrom(decoder: Decoder): StateVector
Decode StateVector TLV.
Parameters
- decoder: Decoder
Returns StateVector
- Defined in svs/src/state-vector.ts:195

Class StateVector

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns StateVector

Parameters

Returns StateVector

Accessors

maxBoot

Returns number

Methods

[iterator]

Returns IterableIterator<[id: Name & StateVector.ID, seqNum: number]>

encodeTo

Parameters

Returns void

get

Parameters

Returns number

Remarks

getEntry

Parameters

Returns NodeEntry

Remarks

listOlderThan

Parameters

Returns DiffEntry[]

mergeFrom

Parameters

Returns void

set

Parameters

Returns void

Remarks

toJSON

Returns Record<string, number>

StaticdecodeFrom

Parameters

Returns StateVector

Settings

On This Page

`Static`decodeFrom