Join us online - 19th of November

Class Dispatcher

Responsible for sending messages from a Source to an associated worker source (usually with the same name).

Index

Constructors

Properties

actors currentActor id workerPool

Methods

broadcast getActor registerMessageHandler remove unregisterMessageHandler

Constructors

constructor

new Dispatcher(workerPool: WorkerPool, mapId: string | number): Dispatcher
Parameters
- workerPool: WorkerPool
- mapId: string | number
Returns Dispatcher

Properties

actors

actors: Actor[]

currentActor

currentActor: number

id

id: string | number

workerPool

workerPool: WorkerPool

Methods

broadcast

broadcast<T extends MessageType>(
type: T,
data: RequestResponseMessageMap[T][0],
): Promise<RequestResponseMessageMap[T][1][]>
Broadcast a message to all Workers.
Type Parameters
- T extends MessageType
Parameters
- type: T
- data: RequestResponseMessageMap[T][0]
Returns Promise<RequestResponseMessageMap[T][1][]>

getActor

getActor(): Actor

Acquires an actor to dispatch messages to. The actors are distributed in round-robin fashion.

Returns Actor
An actor object backed by a web worker for processing messages.

registerMessageHandler

registerMessageHandler<T extends MessageType>(
type: T,
handler: MessageHandler<T>,
): void
Type Parameters
- T extends MessageType
Parameters
- type: T
- handler: MessageHandler<T>
Returns void

remove

remove(mapRemoved?: boolean): void
Parameters
- OptionalmapRemoved: boolean
Returns void

unregisterMessageHandler

unregisterMessageHandler<T extends MessageType>(type: T): void
Type Parameters
- T extends MessageType
Parameters
- type: T
Returns void