Class StateVector

SVS state vector.

Index

Constructors

Methods

[iterator] encodeTo get getEntry listOlderThan mergeFrom set toComponent toJSON decodeFrom fromComponent

Constructors

constructor

new StateVector(from?, lastUpdate?): StateVector
Constructor.
Parameters
- Optional from: Record<string, number> | StateVector
  Copy from state vector or its JSON value.
- lastUpdate: number = 0
  Initial lastUpdate value for each node entry.
Returns StateVector
- Defined in pkg/svs/src/state-vector.ts:14

Methods

[iterator]

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

Returns IterableIterator<[id: Name, seqNum: number]>
- Defined in pkg/svs/src/state-vector.ts:67

encodeTo

encodeTo(encoder): void
Encode TLV-VALUE only.
Parameters
- encoder: Encoder
Returns void
- Defined in pkg/svs/src/state-vector.ts:108

get

get(id): number
Get node sequence number.
Parameters
- id: Name
Returns number
Remarks
If the node does not exist, returns zero.
- Defined in pkg/svs/src/state-vector.ts:34

getEntry

getEntry(id): StateVector.NodeEntry
Get node entry.
Parameters
- id: Name
Returns StateVector.NodeEntry
Remarks
If the node does not exist, returns an entry with seqNum=0.
- Defined in pkg/svs/src/state-vector.ts:44

listOlderThan

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

mergeFrom

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

set

set(id, entry): void
Set node sequence number or entry.
Parameters
- id: Name
- entry: number | StateVector.NodeEntry
  If specified as number, it's interpreted as sequence number, and Date.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 pkg/svs/src/state-vector.ts:57

toComponent

toComponent(): Component
Encode to name component.

Returns Component
Deprecated
No longer supported.
- Defined in pkg/svs/src/state-vector.ts:123

toJSON

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

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

`Static` decodeFrom

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

`Static` fromComponent

fromComponent(comp): StateVector
Decode from name component.
Parameters
- comp: Component
Returns StateVector
Deprecated
No longer supported.
- Defined in pkg/svs/src/state-vector.ts:146