Class ChannelBroker<Topic, Message, RPCRequest, RPCResponse>

constructor

• new ChannelBroker<Topic extends string, Message, RPCRequest, RPCResponse>(): ChannelBroker<
      Topic,
      Message,
      RPCRequest,
      RPCResponse,
  >

  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 ChannelBroker<Topic, Message, RPCRequest, RPCResponse>

ReadonlychannelAttachments

addChannel

• addChannel(
      channel: ActorChannelPair,
      attachment?: ChannelAttachment<Topic>,
  ): void

  Adds a channel to the broker.

  Parameters

  • channel: ActorChannelPair

    The channel transport to add.

  • attachment: ChannelAttachment<Topic> = {}

    Channel metadata, RPC access, and initial topics.

  Returns void

addEventListener

• addEventListener<
      K extends keyof ChannelBrokerEventMap<RPCRequest, RPCResponse, Topic>,
  >(
      type: K,
      listener:
          | ChannelBrokerEventListenerFor<RPCRequest, RPCResponse, K, Topic>
          | null,
      options?: boolean | AddEventListenerOptions,
  ): void

  Registers an event listener.

  Type Parameters

  • K extends keyof ChannelBrokerEventMap<RPCRequest, RPCResponse, Topic>

  Parameters

  • type: K

    The event type.

  • listener: ChannelBrokerEventListenerFor<RPCRequest, RPCResponse, K, Topic> | null

    The listener to register.

  • Optionaloptions: boolean | AddEventListenerOptions

    The event listener options.

  Returns void

deleteChannel

• deleteChannel(channel: ActorChannelPair): void

  Removes a channel and all of its subscriptions from the broker.

  Parameters

  • channel: ActorChannelPair

    The channel transport to remove.

  Returns void

dispatchEvent

• dispatchEvent<
      K extends keyof ChannelBrokerEventMap<RPCRequest, RPCResponse, Topic>,
  >(
      type: K,
      detail: ChannelBrokerEventMap<RPCRequest, RPCResponse, Topic>[K],
  ): void

  Dispatches a broker event to registered listeners.

  Request handlers can use this to report application-level protocol violations associated with the request sender.

  Type Parameters

  • K extends keyof ChannelBrokerEventMap<RPCRequest, RPCResponse, Topic>

  Parameters

  • type: K

    The event type.

  • detail: ChannelBrokerEventMap<RPCRequest, RPCResponse, Topic>[K]

    The event payload.

  Returns void

handleMessage

• handleMessage(sender: ActorChannelPair, message: ArrayBuffer): void

  Handles an encoded protocol message received from a channel.

  Parameters

  • sender: ActorChannelPair

    The channel that sent the message.

  • message: ArrayBuffer

    The MessagePack-encoded protocol message.

  Returns void

markAuthenticated

• markAuthenticated(channel: ActorChannelPair): void

  Marks a channel as authenticated under the host application's identity policy and emits an attachment event.

  This operation is intentionally one-way. Transport authentication remains the responsibility of the server and its HTTPS/WebSocket stack.

  Parameters

  • channel: ActorChannelPair

    The channel whose application-level identity was verified.

  Returns void

removeEventListener

• removeEventListener<
      K extends keyof ChannelBrokerEventMap<RPCRequest, RPCResponse, Topic>,
  >(
      type: K,
      listener:
          | ChannelBrokerEventListenerFor<RPCRequest, RPCResponse, K, Topic>
          | null,
      options?: boolean | EventListenerOptions,
  ): void

  Removes a previously registered event listener.

  Type Parameters

  • K extends keyof ChannelBrokerEventMap<RPCRequest, RPCResponse, Topic>

  Parameters

  • type: K

    The event type.

  • listener: ChannelBrokerEventListenerFor<RPCRequest, RPCResponse, K, Topic> | null

    The listener to remove.

  • Optionaloptions: boolean | EventListenerOptions

    The event listener options.

  Returns void