Class SubscriptionTable<Update>

Track subscriptions in a pubsub protocol. This is primarily useful to pubsub protocol implementors.

Type Parameters

Update extends Event

Hierarchy (View Summary)

NameMultiMap<Subscription<Name, Update>>
- SubscriptionTable

Index

Constructors

Properties

handleRemoveTopic?

Accessors

Methods

[iterator] add associations count list remove subscribe update

Constructors

constructor

new SubscriptionTable<Update extends Event>(): SubscriptionTable<Update>
Type Parameters
- Update extends Event
Returns SubscriptionTable<Update>
Inherited from NameMultiMap.constructor
- Defined in packet/lib/name/name-map.d.ts:15

Properties

`Optional`handleRemoveTopic

handleRemoveTopic?: (topic: Name, objKey: object) => void

Callback when the last subscriber of a topic is removed.

Accessors

dimension

get dimension(): number
Number of distinct keys.

Returns number
Inherited from NameMultiMap.dimension
- Defined in util/lib/key-map.d.ts:39

size

get size(): number
Number of values.

Returns number
Inherited from NameMultiMap.size
- Defined in util/lib/key-map.d.ts:41

Methods

[iterator]

"[iterator]"(): IterableIterator<
    [key: Name, value: Subscription<Name, Update>],
    any,
    any,
>
Iterate over key-value pairs.

Returns IterableIterator<[key: Name, value: Subscription<Name, Update>], any, any>
Inherited from NameMultiMap.[iterator]
- Defined in util/lib/key-map.d.ts:61

add

add(key: Name, value: Subscription<Name, Update>): number
Add a key-value pair. Values are stored in a Set, so duplicates are skipped.
Parameters
- key: Name
- value: Subscription<Name, Update>
Returns number
count(key) after the operation.
Inherited from NameMultiMap.add
- Defined in util/lib/key-map.d.ts:51

associations

associations(): IterableIterator<
    [key: Name, values: ReadonlySet<Subscription<Name, Update>>],
    any,
    any,
>
Iterate over key and associated values.

Returns IterableIterator<
    [key: Name, values: ReadonlySet<Subscription<Name, Update>>],
    any,
    any,
>
Inherited from NameMultiMap.associations
- Defined in util/lib/key-map.d.ts:59

count

count(key: string | Name): number
Count values associated with a key.
Parameters
- key: string | Name
Returns number
Inherited from NameMultiMap.count
- Defined in util/lib/key-map.d.ts:43

list

list(key: string | Name): ReadonlySet<Subscription<Name, Update>>
List values associated with a key.
Parameters
- key: string | Name
Returns ReadonlySet<Subscription<Name, Update>>
Inherited from NameMultiMap.list
- Defined in util/lib/key-map.d.ts:45

remove

remove(key: string | Name, value: Subscription<Name, Update>): number
Remove a key-value pair. No-op if key-value does not exist.
Parameters
- key: string | Name
- value: Subscription<Name, Update>
Returns number
count(key) after the operation.
Inherited from NameMultiMap.remove
- Defined in util/lib/key-map.d.ts:57

subscribe

subscribe(topic: Name): { objKey?: object; sub: Subscription<Name, Update> }
Subscribe to a topic.
Parameters
- topic: Name
  Topic name.
Returns { objKey?: object; sub: Subscription<Name, Update> }
- sub: Subscription object.
- objKey: WeakMap-compatible key associated with the topic, only provided in the first subscription.
- Defined in sync-api/src/subscription-table.ts:35

update

update(
set: Iterable<Subscription<Name, Update>, any, any>,
update: Update,
): void
Deliver an update to a set of subscriptions.
Parameters
- set: Iterable<Subscription<Name, Update>, any, any>
- update: Update
Returns void
Remarks
The caller should ensure the update matches the subscription topic name.
- Defined in sync-api/src/subscription-table.ts:57