Class ClusterManager

Hierarchy

AbstractForkManager<Worker, ClusterOptions>
- ClusterManager

Index

Constructors

constructor

new ClusterManager(options?: ClusterOptions): ClusterManager
Parameters
- options: ClusterOptions = {}
Returns ClusterManager
Overrides AbstractForkManager.constructor
- Defined in packages/bootstrap/src/manager/cp.ts:15

Properties

`Protected` eventBus

eventBus: IEventBus<Worker>

`Readonly` options

options: ClusterOptions = {}

`Protected` workers

workers: Map<string, Worker> = ...

Methods

`Protected` allowRefork

allowRefork(): boolean
allow refork

Returns boolean
Inherited from AbstractForkManager.allowRefork
- Defined in packages/bootstrap/src/manager/base.ts:171

`Protected` bindClose

bindClose(): void
Returns void
Inherited from AbstractForkManager.bindClose
- Defined in packages/bootstrap/src/manager/base.ts:301

bindWorkerDisconnect

bindWorkerDisconnect(listener: ((worker: Worker) => void)): void
Parameters
- listener: ((worker: Worker) => void)
  - - (worker: Worker): void
    - Parameters
      
      worker: Worker
      
      Returns void
Returns void
Overrides AbstractForkManager.bindWorkerDisconnect
- Defined in packages/bootstrap/src/manager/cp.ts:36

bindWorkerExit

bindWorkerExit(listener: ((worker: Worker, code: any, signal: any) => void)): void
Parameters
- listener: ((worker: Worker, code: any, signal: any) => void)
  - - (worker: Worker, code: any, signal: any): void
    - Parameters
      
      worker: Worker
      
      code: any
      
      signal: any
      
      Returns void
Returns void
Overrides AbstractForkManager.bindWorkerExit
- Defined in packages/bootstrap/src/manager/cp.ts:41

closeWorker

closeWorker(worker: Worker): void
Parameters
- worker: Worker
Returns void
Overrides AbstractForkManager.closeWorker
- Defined in packages/bootstrap/src/manager/cp.ts:54

createEventBus

createEventBus(options: any): any
Parameters
- options: any
Returns any
Overrides AbstractForkManager.createEventBus
- Defined in packages/bootstrap/src/manager/cp.ts:58

createWorker

createWorker(): any
Returns any
Overrides AbstractForkManager.createWorker
- Defined in packages/bootstrap/src/manager/cp.ts:23

getWorker

getWorker(workerId: string): Worker
Parameters
- workerId: string
Returns Worker
Inherited from AbstractForkManager.getWorker
- Defined in packages/bootstrap/src/manager/base.ts:289

getWorkerId

getWorkerId(worker: Worker): string
Parameters
- worker: Worker
Returns string
Overrides AbstractForkManager.getWorkerId
- Defined in packages/bootstrap/src/manager/cp.ts:46

getWorkerIds

getWorkerIds(): string[]
Returns string[]
Inherited from AbstractForkManager.getWorkerIds
- Defined in packages/bootstrap/src/manager/base.ts:293

hasWorker

hasWorker(workerId: string): boolean
Parameters
- workerId: string
Returns boolean
Inherited from AbstractForkManager.hasWorker
- Defined in packages/bootstrap/src/manager/base.ts:285

isPrimary

isPrimary(): boolean
Returns boolean
Overrides AbstractForkManager.isPrimary
- Defined in packages/bootstrap/src/manager/cp.ts:62

isWorkerDead

isWorkerDead(worker: Worker): boolean
Parameters
- worker: Worker
Returns boolean
Overrides AbstractForkManager.isWorkerDead
- Defined in packages/bootstrap/src/manager/cp.ts:50

`Protected` killWorker

killWorker(worker: any, timeout: any): Promise<void>
Parameters
- worker: any
- timeout: any
Returns Promise<void>
Inherited from AbstractForkManager.killWorker
- Defined in packages/bootstrap/src/manager/base.ts:259

`Protected` onReachReforkLimit

onReachReforkLimit(): void
reachReforkLimit default handler

Returns void
Inherited from AbstractForkManager.onReachReforkLimit
- Defined in packages/bootstrap/src/manager/base.ts:249

onStop

onStop(exitListener: any): void
Parameters
- exitListener: any
Returns void
Inherited from AbstractForkManager.onStop
- Defined in packages/bootstrap/src/manager/base.ts:297

`Protected` onUnexpected

onUnexpected(worker: Worker, code: any, signal: any): void
unexpectedExit default handler
Parameters
- worker: Worker
- code: any
- signal: any
Returns void
Inherited from AbstractForkManager.onUnexpected
- Defined in packages/bootstrap/src/manager/base.ts:217

`Protected` onerror

onerror(err: any): void
uncaughtException default handler
Parameters
- err: any
Returns void
Inherited from AbstractForkManager.onerror
- Defined in packages/bootstrap/src/manager/base.ts:196

start

start(): Promise<void>
Returns Promise<void>
Inherited from AbstractForkManager.start
- Defined in packages/bootstrap/src/manager/base.ts:36

stop

stop(timeout?: number): Promise<void>
Parameters
- timeout: number = 2000
Returns Promise<void>
Inherited from AbstractForkManager.stop
- Defined in packages/bootstrap/src/manager/base.ts:271

`Protected` tryToRefork

tryToRefork(oldWorker: Worker): void
Parameters
- oldWorker: Worker
Returns void
Inherited from AbstractForkManager.tryToRefork
- Defined in packages/bootstrap/src/manager/base.ts:138

Generated using TypeDoc