Class AbstractForkManager<T, ClusterOptions>`Abstract`

Type Parameters

T
ClusterOptions extends ForkOptions

Hierarchy

AbstractForkManager
- ClusterManager

Index

Constructors

`Protected` constructor

new AbstractForkManager<T, ClusterOptions>(options: ClusterOptions): AbstractForkManager<T, ClusterOptions>
Type Parameters
- T
- ClusterOptions extends ForkOptions
Parameters
- options: ClusterOptions
Returns AbstractForkManager<T, ClusterOptions>
- Defined in packages/bootstrap/src/manager/base.ts:24

Properties

`Protected` eventBus

eventBus: IEventBus<T>

`Readonly` options

options: ClusterOptions

`Protected` workers

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

Methods

`Protected` allowRefork

allowRefork(): boolean
allow refork

Returns boolean
- Defined in packages/bootstrap/src/manager/base.ts:171

`Protected` bindClose

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

`Abstract` bindWorkerDisconnect

bindWorkerDisconnect(listener: ((worker: T) => void)): void
Parameters
- listener: ((worker: T) => void)
  - - (worker: T): void
    - Parameters
      
      worker: T
      
      Returns void
Returns void
- Defined in packages/bootstrap/src/manager/base.ts:343

`Abstract` bindWorkerExit

bindWorkerExit(listener: ((worker: T, code: any, signal: any) => void)): void
Parameters
- listener: ((worker: T, code: any, signal: any) => void)
  - - (worker: T, code: any, signal: any): void
    - Parameters
      
      worker: T
      
      code: any
      
      signal: any
      
      Returns void
Returns void
- Defined in packages/bootstrap/src/manager/base.ts:344

`Abstract` closeWorker

closeWorker(worker: T): any
Parameters
- worker: T
Returns any
- Defined in packages/bootstrap/src/manager/base.ts:347

`Abstract` createEventBus

createEventBus(eventBusOptions: EventBusOptions): IEventBus<T>
Parameters
- eventBusOptions: EventBusOptions
Returns IEventBus<T>
- Defined in packages/bootstrap/src/manager/base.ts:348

`Abstract` createWorker

createWorker(oldWorker?: T): T
Parameters
- Optional oldWorker: T
Returns T
- Defined in packages/bootstrap/src/manager/base.ts:342

getWorker

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

`Abstract` getWorkerId

getWorkerId(worker: T): string
Parameters
- worker: T
Returns string
- Defined in packages/bootstrap/src/manager/base.ts:345

getWorkerIds

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

hasWorker

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

`Abstract` isPrimary

isPrimary(): boolean
Returns boolean
- Defined in packages/bootstrap/src/manager/base.ts:349

`Abstract` isWorkerDead

isWorkerDead(worker: T): boolean
Parameters
- worker: T
Returns boolean
- Defined in packages/bootstrap/src/manager/base.ts:346

`Protected` killWorker

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

`Protected` onReachReforkLimit

onReachReforkLimit(): void
reachReforkLimit default handler

Returns void
- Defined in packages/bootstrap/src/manager/base.ts:249

onStop

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

`Protected` onUnexpected

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

`Protected` onerror

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

start

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

stop

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

`Protected` tryToRefork

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

Generated using TypeDoc