Interface PeerAwareMessageBus<OutMsg, Peer, InMsg>

A peer-aware MessageBus.

interface PeerAwareMessageBus {
    addEventListener<K>(type, listener): void;
    dispatch(message, options?): MaybePromise<void>;
    removeEventListener<K>(type, listener): void;
    subscribe(handler, options?): MaybePromise<Unsubscribe>;
    subscribers(options?): MaybePromise<Iterable<Peer>>;
    topics(options?): MaybePromise<Iterable<string>>;
}

Type Parameters

OutMsg
Peer = unknown
InMsg = OutMsg

Hierarchy

MessageBus<OutMsg, InMsg, PeerAwareMessageOptions<Peer>>
MessageSubscriptionState<Peer>
PeerEventSource<Peer>
- PeerAwareMessageBus

Implemented by

BroadcastChannelMessageBus

Index

Methods

addEventListener dispatch removeEventListener subscribe subscribers topics

Methods

addEventListener

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

dispatch

dispatch(message, options?): MaybePromise<void>
Dispatches a message.
Parameters
- message: OutMsg
- Optional options: MessageOptions
Returns MaybePromise<void>
Inherited from MessageBus.dispatch
- Defined in packages/messaging/src/messaging.ts:14

removeEventListener

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

subscribe(handler, options?): MaybePromise<Unsubscribe>
Subscribes to new messages and returns a handle to unsubscribe.
Parameters
- handler: MessageHandler<InMsg, PeerAwareMessageOptions<Peer>>
- Optional options: SubscribeOptions<InMsg, PeerAwareMessageOptions<Peer>>
Returns MaybePromise<Unsubscribe>
Inherited from MessageBus.subscribe
- Defined in packages/messaging/src/messaging.ts:20

subscribers

subscribers(options?): MaybePromise<Iterable<Peer>>
Returns the list of peers that are subscribed to a topic.
Parameters
- Optional options: MessageOptions
Returns MaybePromise<Iterable<Peer>>
Inherited from MessageSubscriptionState.subscribers
- Defined in packages/messaging/src/peer-aware.ts:25

topics

topics(options?): MaybePromise<Iterable<string>>
Returns the list of subscribed topics for this node.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<Iterable<string>>
Inherited from MessageSubscriptionState.topics
- Defined in packages/messaging/src/peer-aware.ts:19

Interface PeerAwareMessageBus<OutMsg, Peer, InMsg>

Type Parameters

OutMsg

Peer = unknown

InMsg = OutMsg

Hierarchy

Implemented by

Index

Methods

Methods

addEventListener

Type Parameters

K extends PeerEvent

Parameters

type: K

listener: TypedEventHandler<Extract<TypedCustomEvent<Join, PeerChangeData<Peer>>, TypedEvent<K>> | Extract<TypedCustomEvent<Leave, PeerChangeData<Peer>>, TypedEvent<K>>, unknown>

Returns void

dispatch

Parameters

message: OutMsg

Optional options: MessageOptions

Returns MaybePromise<void>

removeEventListener

Type Parameters

K extends PeerEvent

Parameters

type: K

listener: TypedEventHandler<Extract<TypedCustomEvent<Join, PeerChangeData<Peer>>, TypedEvent<K>> | Extract<TypedCustomEvent<Leave, PeerChangeData<Peer>>, TypedEvent<K>>, unknown>

Returns void

subscribe

Parameters

handler: MessageHandler<InMsg, PeerAwareMessageOptions<Peer>>

Optional options: SubscribeOptions<InMsg, PeerAwareMessageOptions<Peer>>

Returns MaybePromise<Unsubscribe>

subscribers

Parameters

Optional options: MessageOptions

Returns MaybePromise<Iterable<Peer>>

topics

Parameters

Optional options: AbortOptions

Returns MaybePromise<Iterable<string>>

Settings

Member Visibility

Theme

On This Page

`Optional` options: MessageOptions

`Optional` options: SubscribeOptions<InMsg, PeerAwareMessageOptions<Peer>>

`Optional` options: MessageOptions

`Optional` options: AbortOptions