Class PeerSubscriptionMonitor<Peer>

Monitor of topic peers from MessageSubscriptionState.

Type Parameters

Peer extends StringEquatable<Peer>

Hierarchy

TypedEventTarget<PeerEvents<Peer>>
- PeerSubscriptionMonitor

Implements

Startable
Disposable

Index

Constructors

Properties

bus peers pollTimer refreshMs

Accessors

Methods

[dispose] addEventListener close dispatchEvent pollPeers removeEventListener start updateTopicPeers updateTopics

Constructors

constructor

new PeerSubscriptionMonitor<Peer>(bus, refreshMs?, start?): PeerSubscriptionMonitor<Peer>
Type Parameters
- Peer extends StringEquatable<Peer>
Parameters
- bus: MessageSubscriptionState<Peer>
  MessageSubscriptionState instance.
- refreshMs: number = DEFAULT_PEER_MONITOR_REFRESH_MS
  Peer list refresh interval in milliseconds.
- start: boolean = true
  whether to start the monitor immediately.
Returns PeerSubscriptionMonitor<Peer>
Overrides TypedEventTarget.constructor
- Defined in packages/messaging/src/utils/peer-monitor.ts:15

Properties

`Private` `Readonly` bus

bus: MessageSubscriptionState<Peer>

MessageSubscriptionState instance.

`Private` `Readonly` peers

peers: Map<string, Peer[]> = ...

`Private` pollTimer

pollTimer: number = 0

`Private` `Readonly` refreshMs

refreshMs: number = DEFAULT_PEER_MONITOR_REFRESH_MS

Peer list refresh interval in milliseconds.

Accessors

started

get started(): boolean
Returns if this monitor is running.

Returns boolean
Implementation of Startable.started
- Defined in packages/messaging/src/utils/peer-monitor.ts:38

Methods

[dispose]

[dispose](): void
Returns void
Implementation of Disposable.[dispose]
- Defined in packages/messaging/src/utils/peer-monitor.ts:33

addEventListener

addEventListener<K>(type, listener): void
Registers an event handler of a specific event type.
Type Parameters
- K extends PeerEvent
Parameters
- type: K
- listener: null | TypedEventHandler<Extract<TypedCustomEvent<Join, PeerChangeData<Peer>>, TypedEvent<K>> | Extract<TypedCustomEvent<Leave, PeerChangeData<Peer>>, TypedEvent<K>>, unknown>
Returns void
Inherited from TypedEventTarget.addEventListener
- Defined in packages/commons/dist/event.d.ts:39

close

close(): void
Closes this object and releases any system resource associated with it.

Returns void
Implementation of Startable.close
- Defined in packages/messaging/src/utils/peer-monitor.ts:27

dispatchEvent

dispatchEvent<K>(event): boolean
Dispatches the event to the list of handlers for event.type.
Type Parameters
- K extends PeerEvent
Parameters
- event: Extract<TypedCustomEvent<Join, PeerChangeData<Peer>>, TypedEvent<K>> | Extract<TypedCustomEvent<Leave, PeerChangeData<Peer>>, TypedEvent<K>>
Returns boolean
false if event is cancelled; true otherwise.
Inherited from TypedEventTarget.dispatchEvent
- Defined in packages/commons/dist/event.d.ts:41

`Private` pollPeers

pollPeers(): Promise<void>
Returns Promise<void>
- Defined in packages/messaging/src/utils/peer-monitor.ts:49

removeEventListener

removeEventListener<K>(type, listener): void
Removes an event listener.
Type Parameters
- K extends PeerEvent
Parameters
- type: K
- listener: null | TypedEventHandler<Extract<TypedCustomEvent<Join, PeerChangeData<Peer>>, TypedEvent<K>> | Extract<TypedCustomEvent<Leave, PeerChangeData<Peer>>, TypedEvent<K>>, unknown>
Returns void
Inherited from TypedEventTarget.removeEventListener
- Defined in packages/commons/dist/event.d.ts:40

start

start(): void
Starts this monitor.

Returns void
Implementation of Startable.start
- Defined in packages/messaging/src/utils/peer-monitor.ts:43

`Private` updateTopicPeers

updateTopicPeers(topic, peers): Promise<void>
Updates the peers list with the latest peers and emit join/leave events
Parameters
- topic: string
- peers: Peer[]
Returns Promise<void>
- Defined in packages/messaging/src/utils/peer-monitor.ts:72

`Private` updateTopics

updateTopics(): Promise<void>
Clean up the peers list based on currently subscribed topics.

Returns Promise<void>
- Defined in packages/messaging/src/utils/peer-monitor.ts:57

Generated using TypeDoc