ClusterProcess | Detritus Client

Hierarchy

EventSpewer
- ClusterProcess

Index

Constructors

constructor

Properties

Accessors

file

Constructors

constructor

new ClusterProcess(manager: ClusterManager, options: ClusterProcessOptions): ClusterProcess

Overrides EventSpewer.constructor
- Defined in src/cluster/process.ts:37
Parameters
- manager: ClusterManager
- options: ClusterProcessOptions
Returns ClusterProcess

Properties

Readonly _evalsWaiting

_evalsWaiting: BaseCollection<string, { promise: Promise<any>; reject: Function; resolve: Function }> = ...

Readonly _shardsWaiting

_shardsWaiting: BaseCollection<number, { reject: Function; resolve: Function }> = ...

Readonly clusterId

clusterId: number = -1

env

env: Record<string, undefined | string> = {}

Readonly manager

manager: ClusterManager

process

process: null | ChildProcess = null

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

file

get file(): string

- Defined in src/cluster/process.ts:61
Returns string

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ClusterProcess

Inherited from EventSpewer.addListener
- Defined in node_modules/@types/node/events.d.ts:57
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClusterProcess

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventSpewer.emit
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eval

eval(code: string | Function, nonce: string): Promise<null | [any, boolean]>

- Defined in src/cluster/process.ts:211
Parameters
- code: string | Function
- nonce: string
Returns Promise<null | [any, boolean]>

eventNames

eventNames(): (string | symbol)[]

Inherited from EventSpewer.eventNames
- Defined in node_modules/@types/node/events.d.ts:72
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from EventSpewer.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:64
Returns number

hasEventListener

hasEventListener(name: string | symbol): boolean

Inherited from EventSpewer.hasEventListener
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:16
Parameters
- name: string | symbol
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventSpewer.listenerCount
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventSpewer.listeners
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): ClusterProcess

Inherited from EventSpewer.off
- Defined in node_modules/@types/node/events.d.ts:61
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClusterProcess

on

on(event: string | symbol, listener: (...args: any[]) => void): ClusterProcess
on(event: "ready", listener: () => any): ClusterProcess
on(event: "shardClose", listener: (data: Close) => any): ClusterProcess
on(event: "shardState", listener: (data: ShardState) => any): ClusterProcess
on(event: "warn", listener: (payload: { error: Error }) => any): ClusterProcess

Overrides EventSpewer.on
- Defined in src/cluster/process.ts:326
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClusterProcess
Overrides EventSpewer.on
- Defined in src/cluster/process.ts:327
Parameters
- event: "ready"
- listener: () => any
  - - (): any
    - Returns any
Returns ClusterProcess
Overrides EventSpewer.on
- Defined in src/cluster/process.ts:328
Parameters
- event: "shardClose"
- listener: (data: Close) => any
  - - (data: Close): any
    - Parameters
      - data: Close
      Returns any
Returns ClusterProcess
Overrides EventSpewer.on
- Defined in src/cluster/process.ts:329
Parameters
- event: "shardState"
- listener: (data: ShardState) => any
  - - (data: ShardState): any
    - Parameters
      - data: ShardState
      Returns any
Returns ClusterProcess
Overrides EventSpewer.on
- Defined in src/cluster/process.ts:330
Parameters
- event: "warn"
- listener: (payload: { error: Error }) => any
  - - (payload: { error: Error }): any
    - Parameters
      - payload: { error: Error }
        
        error: Error
      Returns any
Returns ClusterProcess

onExit

onExit(code: number, signal: string): Promise<void>

- Defined in src/cluster/process.ts:186
Parameters
- code: number
- signal: string
Returns Promise<void>

onMessage

onMessage(message: any): Promise<void>

- Defined in src/cluster/process.ts:65
Parameters
- message: any
Returns Promise<void>

once

once(event: string | symbol, listener: (...args: any[]) => void): ClusterProcess

Inherited from EventSpewer.once
- Defined in node_modules/@types/node/events.d.ts:59
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClusterProcess

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ClusterProcess

Inherited from EventSpewer.prependListener
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClusterProcess

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ClusterProcess

Inherited from EventSpewer.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClusterProcess

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventSpewer.rawListeners
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(name?: string | symbol): ClusterProcess

Inherited from EventSpewer.removeAllListeners
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:19
Parameters
- Optional name: string | symbol
Returns ClusterProcess

removeAllSubscriptions

removeAllSubscriptions(): ClusterProcess

Inherited from EventSpewer.removeAllSubscriptions
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:20
Returns ClusterProcess

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ClusterProcess

Inherited from EventSpewer.removeListener
- Defined in node_modules/@types/node/events.d.ts:60
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ClusterProcess

removeSubscription

removeSubscription(subscription: EventSubscription): void

Inherited from EventSpewer.removeSubscription
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:18
Parameters
- subscription: EventSubscription
Returns void

run

run(options?: ClusterProcessRunOptions): Promise<ChildProcess>

- Defined in src/cluster/process.ts:294
Parameters
- options: ClusterProcessRunOptions = {}
Returns Promise<ChildProcess>

send

send(message: any): Promise<void>

- Defined in src/cluster/process.ts:269
Parameters
- message: any
Returns Promise<void>

sendIPC

sendIPC(op: number, data?: any, request?: boolean, shard?: number, clusterId?: number): Promise<void>

- Defined in src/cluster/process.ts:284
Parameters
- op: number
- data: any = null
- request: boolean = false
- Optional shard: number
- Optional clusterId: number
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): ClusterProcess

Inherited from EventSpewer.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- n: number
Returns ClusterProcess

subscribe(name: string | symbol, listener: (...args: any[]) => void): EventSubscription

Inherited from EventSpewer.subscribe
- Defined in node_modules/detritus-utils/lib/eventspewer.d.ts:17
Parameters
- name: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns EventSubscription

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventSpewer.listenerCount
- Defined in node_modules/@types/node/events.d.ts:26
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

Inherited from EventSpewer.on
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

Inherited from EventSpewer.once
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
Inherited from EventSpewer.once
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

manager: ClusterManager

options: ClusterProcessOptions

Returns ClusterProcess

Properties

Readonly _evalsWaiting

Readonly _shardsWaiting

Readonly clusterId

env

Readonly manager

process

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

file

Returns string

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClusterProcess

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eval

Parameters

code: string | Function

nonce: string

Returns Promise<null | [any, boolean]>

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

hasEventListener

Parameters

name: string | symbol

Returns boolean

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClusterProcess

on

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ClusterProcess

Parameters

event: "ready"

listener: () => any