WorkerDispatch

This class provides a Worker with the means to participate in the message dispatch system managed by CentralDispatch. From any context in the messaging system, the dispatcher's "call" method can call any method on any "service" provided in any participating context. The dispatch system will forward function arguments and return values across worker boundaries as needed.

Constructor

new WorkerDispatch()

See:

{CentralDispatch}

Members

(private) _connectionPromise :Promise

See:

{waitForConnection}

This promise will be resolved when we have successfully connected to central dispatch.

Type:

Promise

services :object

See:

{setService}

Map of service name to local service provider. If a service is not listed here, it is assumed to be provided by another context (another Worker or the main thread).

Type:

object

waitForConnection

Example

dispatch.waitForConnection.then(() => {
         dispatch.call('myService', 'hello');
     })

Methods

(protected) _getServiceProvider(service) → {Object}

Fetch the service provider object for a particular service name.

Parameters:

Name	Type	Description
`service`	string	the name of the service to look up

Returns:

the means to contact the service, if found

Type: Object

(protected) _onDispatchMessage(worker, message) → {Promise|undefined}

Handle a call message sent to the dispatch service itself

Parameters:

Name	Type	Description
`worker`	Worker	the worker which sent the message.
`message`	DispatchCallMessage	the message to be handled.

Returns:

a promise for the results of this operation, if appropriate

Type: Promise | undefined

setService(service, provider) → {Promise}

Set a local object as the global provider of the specified service. WARNING: Any method on the provider can be called from any worker within the dispatch system.

Parameters:

Name	Type	Description
`service`	string	a globally unique string identifying this service. Examples: 'vm', 'gui', 'extension9'.
`provider`	object	a local object which provides this service.

Returns:

a promise which will resolve once the service is registered.

Type: Promise