Class SvStateVector

SVS state vector.

Index

Constructors

Methods

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

Constructors

constructor

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

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/lib/state-vector.d.ts:37

encodeTo

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

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/lib/state-vector.d.ts:18

getEntry

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

listOlderThan

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

mergeFrom

mergeFrom(other, lastUpdate?): void
Update this state vector to have newer sequence numbers between this and other.
Parameters
- other: SvStateVector
- Optional lastUpdate: number
Returns void
- Defined in pkg/svs/lib/state-vector.d.ts:42

set

set(id, entry): void
Set node sequence number or entry.
Parameters
- id: Name
- entry: number | SvStateVector.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/lib/state-vector.d.ts:35

toComponent

toComponent(): Component
Encode to name component.

Returns Component
Deprecated
No longer supported.
- Defined in pkg/svs/lib/state-vector.d.ts:51

toJSON

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

Returns Record<string, number>
- Defined in pkg/svs/lib/state-vector.d.ts:44

`Static` decodeFrom

decodeFrom(decoder): SvStateVector
Decode TLV-VALUE only.
Parameters
- decoder: Decoder
Returns SvStateVector
- Defined in pkg/svs/lib/state-vector.d.ts:53

`Static` fromComponent

fromComponent(comp): SvStateVector
Decode from name component.
Parameters
- comp: Component
Returns SvStateVector
Deprecated
No longer supported.
- Defined in pkg/svs/lib/state-vector.d.ts:58