ResourceFaçade

ResourceFaçade

ResourceFaçade is a thin IPC façade for actual resource running in a separate process. Constructor requires actual job instance just to instantiate a resource from its createResource call, separate run call is required to start it.

Constructor

new ResourceFaçade(job, file)

Description:
  • Constructor

Source:
Parameters:
Name Type Description
job Job

for resource

file string

Members

isBusy

Description:
  • Check if resource is busy

Source:

Check if resource is busy

isReady

Description:
  • Check if resource is ready

Source:

Check if resource is ready

Methods

abort(job) → {Promise}

Description:
  • Abort job

Source:
Parameters:
Name Type Description
job Job

to abort

Returns:

promise

Type
Promise

canBeTerminated() → {boolean}

Description:
  • Whether manager is allowed to terminate process on master exit Uses opened event data to know if underlying resource can be terminated

Source:
Returns:

true if manager can;

Type
boolean

close() → {Promise}

Description:
  • Close resource

Source:
Returns:

promise

Type
Promise

kill() → {Promise}

Description:
  • Kill resource

Source:
Returns:

promise

Type
Promise

open() → {Promise}

Description:
  • Open resource

Source:
Returns:

promise

Type
Promise

reject(error)

Description:
  • Reject job

Source:
Parameters:
Name Type Description
error Error

with which to reject

resolve()

Description:
  • Resolve job

Source:

run(job) → {Promise}

Description:
  • Run job

Source:
Parameters:
Name Type Description
job Job

to run

Returns:

promise

Type
Promise