Class ActorChannel<Topic, Message, RPCRequest, RPCResponse>

Coordinates RPC requests and topic messages across the current browsing context, other same-origin browsing contexts, and connected brokers.

Type Parameters

Topic extends string
The topic identifier type.
Message
The published message type.
RPCRequest
The RPC request payload type.
RPCResponse
The RPC response payload type.

Index

Constructors

Accessors

Methods

addBroker addEventListener publish removeEventListener request subscribe unsubscribe

Constructors

constructor

new ActorChannel<Topic extends string, Message, RPCRequest, RPCResponse>(): ActorChannel<
    Topic,
    Message,
    RPCRequest,
    RPCResponse,
>
Creates an actor channel for the current browsing context.
Type Parameters
- Topic extends string
  The topic identifier type.
- Message
  The published message type.
- RPCRequest
  The RPC request payload type.
- RPCResponse
  The RPC response payload type.
Returns ActorChannel<Topic, Message, RPCRequest, RPCResponse>
- Defined in ActorChannel/index.ts:136

Accessors

rpcAvailable

get rpcAvailable(): boolean
Whether at least one RPC-enabled broker is currently available.

Returns boolean
- Defined in ActorChannel/index.ts:43

Methods

addBroker

addBroker(brokerUrl: string, rpcEnabled?: boolean): Promise<void>
Maintains a best-effort connection to a broker while this channel owns the broker URL's Web Lock.
Parameters
- brokerUrl: string
  The broker WebSocket URL.
- rpcEnabled: boolean = false
  Whether the connection may carry RPC requests.
Returns Promise<void>
A promise that settles when connection maintenance stops.
- Defined in ActorChannel/index.ts:239

addEventListener

addEventListener<
    K extends keyof ActorChannelEventMap<RPCResponse, Topic, Message>,
>(
    type: K,
    listener:
        | ActorChannelEventListenerFor<RPCResponse, Topic, Message, K>
        | null,
    options?: boolean | AddEventListenerOptions,
): void
Registers an event listener.
Type Parameters
- K extends keyof ActorChannelEventMap<RPCResponse, Topic, Message>
Parameters
- type: K
  The event type.
- listener: ActorChannelEventListenerFor<RPCResponse, Topic, Message, K> | null
  The listener to register.
- Optionaloptions: boolean | AddEventListenerOptions
  The event listener options.
Returns void
- Defined in ActorChannel/index.ts:463

publish

publish(topic: Topic, detail: Message): void
Publishes a message to the local swarm and subscribed broker peers.
Parameters
- topic: Topic
  The topic to publish to.
- detail: Message
  The message payload.
Returns void
- Defined in ActorChannel/index.ts:81

removeEventListener

removeEventListener<
    K extends keyof ActorChannelEventMap<RPCResponse, Topic, Message>,
>(
    type: K,
    listener:
        | ActorChannelEventListenerFor<RPCResponse, Topic, Message, K>
        | null,
    options?: boolean | EventListenerOptions,
): void
Removes a previously registered event listener.
Type Parameters
- K extends keyof ActorChannelEventMap<RPCResponse, Topic, Message>
Parameters
- type: K
  The event type.
- listener: ActorChannelEventListenerFor<RPCResponse, Topic, Message, K> | null
  The listener to remove.
- Optionaloptions: boolean | EventListenerOptions
  The event listener options.
Returns void
- Defined in ActorChannel/index.ts:489

request

request(detail: RPCRequest): string
Sends an RPC request to an available RPC-enabled broker.

The request is not queued when no RPC-enabled broker is available.
Parameters
- detail: RPCRequest
  The request payload.
Returns string
The identifier assigned to the request.
- Defined in ActorChannel/index.ts:61

subscribe(topic: Topic): void
Subscribes this browsing context to a topic.

Repeated subscriptions to the same topic have no effect.
Parameters
- topic: Topic
  The topic to subscribe to.
Returns void
- Defined in ActorChannel/index.ts:99

unsubscribe

unsubscribe(topic: Topic): void
Removes this browsing context's subscription to a topic.
Parameters
- topic: Topic
  The topic to unsubscribe from.
Returns void
- Defined in ActorChannel/index.ts:118