Fleet | eris-fleet

The sharding manager.

example

const { isMaster } = require('cluster');
const { Fleet } = require('eris-fleet');
const path = require('path');
const { inspect } = require('util');
require('dotenv').config();

const options = {
    path: path.join(__dirname, "./bot.js"),
    token: process.env.token
}

const Admiral = new Fleet(options);

if (isMaster) {
    // Code to only run for your master process
    Admiral.on('log', m => console.log(m));
    Admiral.on('debug', m => console.debug(m));
    Admiral.on('warn', m => console.warn(m));
    Admiral.on('error', m => console.error(inspect(m)));

    // Logs stats when they arrive
    Admiral.on('stats', m => console.log(m));
}

fires

Admiral#log Message to log. Supplies either a message or an ObjectLog.

fires

Admiral#debug Debug message to log. Supplies either a message or an ObjectLog.

fires

Admiral#warn Warning message to log. Supplies either a message or an ObjectLog.

fires

Admiral#error Error to log. Supplies either a message or an ObjectLog.

fires

Admiral#clusterReady Fires when a cluster is ready. Supplies Cluster Object.

fires

Admiral#serviceReady Fires when a service is ready. Supplies Service Object.

fires

Admiral#clusterShutdown Fires when a cluster is shutdown. Supplies Cluster Object.

fires

Admiral#serviceShutdown Fires when a service is shutdown. Supplies Service Object.

fires

Admiral#ready Fires when the queue is empty.

fires

Admiral#stats Fires when stats are ready. Supplies Stats

fires

Admiral#reshardingComplete Fires when resharding completes.

fires

Admiral#shardReady Fires when a shard is ready. Supplies ShardUpdate.

fires

Admiral#shardConnect Fires when a shard connects. Supplies ShardUpdate.

fires

Admiral#shardDisconnect Fires when a shard disconnects. Supplies ShardUpdate.

fires

Admiral#shardResume Fires when a shard resumes. Supplies ShardUpdate.

Hierarchy

EventEmitter
- Fleet

Index

Constructors

constructor

Constructors

constructor

new Fleet(options: Options): Fleet

Overrides EventEmitter.constructor
- Defined in src/sharding/Admiral.ts:458
Creates the sharding manager

Parameters
- options: Options
  
  Options to configure the sharding manager
Returns Fleet

Properties

Optional BotWorker

BotWorker?: typeof BaseClusterWorker

BotWorker class used when starting clusters

Private broadcastAdmiralEvents

broadcastAdmiralEvents: boolean

centralStore

centralStore: Map<string, any>

Central storage map

Private Optional chunks

chunks?: number[][]

Private clientOptions

clientOptions: ClientOptions

clusterCount

clusterCount: number | "auto"

clusterTimeout

clusterTimeout: number

clusters

clusters: Collection<number, ClusterCollection>

Map of clusters by ID

Private clustersSequentialFailedRestarts

clustersSequentialFailedRestarts: Map<number, number>

Map of cluster ID to sequential failed restarts

Private collectingStats

collectingStats: boolean

Private connectedClusterGroups

connectedClusterGroups: Map<number, number>

Map of cluster group number to the number of times that group's members have connected

eris

eris: Client

Eris client used to get the gateway information and to send requests when using the central request handler

Private erisClient

erisClient: typeof Client

Private fetchTimeout

fetchTimeout: number

Private fetches

fetches: Map<string, { UUID: number | "master"; checked: number; id: string | number; op: string }>

firstShardID

firstShardID: number

guildsPerShard

guildsPerShard: number | "auto"

ipc

ipc: IPC

IPC for the Admiral which functions like the worker IPC classes. Has some redundant functions which already exist on the Admiral class.

killTimeout

killTimeout: number

lastShardID

lastShardID: number

Private launchingManager

launchingManager: Map<number, { waiting: any } | "launched">

Private launchingWorkers

launchingWorkers: Collection<number, WorkerCollection>

Maps of workers currently launching by ID

Private loadClusterCodeImmediately

loadClusterCodeImmediately: boolean

Private maxConcurrency

maxConcurrency: number

Private Optional maxConcurrencyOverride

maxConcurrencyOverride?: number

Private maxRestarts

maxRestarts: number

Private Optional nodeArgs

nodeArgs?: string[]

Private objectLogging

objectLogging: boolean

Private overrideConsole

overrideConsole: boolean

Optional path

path?: string

Path used when starting clusters

Private pauseStats

pauseStats: boolean

Private Optional prelimStats

prelimStats?: Stats

Private queue

queue: Queue

Private resharding

resharding: boolean

serviceTimeout

serviceTimeout: number

services

services: Collection<string, ServiceCollection>

Map of services by name

Private servicesSequentialFailedRestarts

servicesSequentialFailedRestarts: Map<string, number>

Map of service name to sequential failed restarts

Private Optional servicesToCreate

servicesToCreate?: ServiceCreator[]

Services to create

shardCount

shardCount: number | "auto"

Private shutdownTogether

shutdownTogether: boolean

Private softKills

softKills: Map<number, { id?: string | number; type?: "cluster" | "service"; fn: any }>

Private startServicesTogether

startServicesTogether: boolean

Private Optional startingStatus

startingStatus?: StartingStatus

Optional stats

stats?: Stats

Current stats

Private statsInterval

statsInterval: number | "disable"

Private statsStarted

statsStarted: boolean

Private Optional statsWorkersCounted

statsWorkersCounted?: number

Private token

token: string

Private useCentralRequestHandler

useCentralRequestHandler: boolean

Private whatToLog

whatToLog: LoggingOptions[]

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.

Methods

addListener

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

Inherited from EventEmitter.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 Fleet

broadcast

broadcast(op: string, msg?: unknown): void

- Defined in src/sharding/Admiral.ts:2012
Broadcast an event to all clusters and services. The event can be listened to with register
example
```
admiral.broadcast("hello clusters!", "Want to chat?");
```
Parameters
- op: string
  
  Name of the event
- Optional msg: unknown
Returns void

Private calculateShards

calculateShards(): Promise<number>

- Defined in src/sharding/Admiral.ts:2176
Returns Promise<number>

Private centralApiRequest

centralApiRequest(worker: Worker, UUID: string, data: { _route?: string; auth?: boolean; body?: {}; file?: FileContent; fileString?: string; method: RequestMethod; short?: boolean; url: string }): void

- Defined in src/sharding/Admiral.ts:1664
Parameters
- worker: Worker
- UUID: string
- data: { _route?: string; auth?: boolean; body?: {}; file?: FileContent; fileString?: string; method: RequestMethod; short?: boolean; url: string }
  - Optional _route?: string
  - Optional auth?: boolean
  - Optional body?: {}
    - [s: string]: unknown
  - Optional file?: FileContent
  - Optional fileString?: string
  - method: RequestMethod
  - Optional short?: boolean
  - url: string
Returns void

Private chunk

chunk(shards: number[], clusters: number): number[][]

- Defined in src/sharding/Admiral.ts:2210
Parameters
- shards: number[]
- clusters: number
Returns number[][]

Private chunkConcurrencyGroups

chunkConcurrencyGroups(): Map<number, number>

- Defined in src/sharding/Admiral.ts:2198
Returns Map<number, number>

collectStats

collectStats(): Promise<Stats>

- Defined in src/sharding/Admiral.ts:2033
Force eris-fleet to fetch fresh stats

Returns Promise<Stats>
Promise with stats

createService

createService(serviceName: string, service: string | typeof BaseServiceWorker): void

- Defined in src/sharding/Admiral.ts:1829
Create a service
example
```
const path = require("path");
admiral.createService("myService", path.join(__dirname, "./service.js"))
```
Parameters
- serviceName: string
  
  Unique ame of the service
- service: string | typeof BaseServiceWorker
  
  Absolute path to the service file or your ServiceWorker class (extends BaseServiceWorker)
Returns void

debug

debug(message: unknown, source?: string): void

- Defined in src/sharding/Admiral.ts:2681
Parameters
- message: unknown
- Optional source: string
Returns void

emit

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

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

Private emitLog

emitLog(type: "log" | "info" | "error" | "warn" | "debug", message: unknown, source?: string): void

- Defined in src/sharding/Admiral.ts:2661
Parameters
- type: "log" | "info" | "error" | "warn" | "debug"
- message: unknown
- Optional source: string
Returns void

error

error(message: unknown, source?: string): void

- Defined in src/sharding/Admiral.ts:2677
Parameters
- message: unknown
- Optional source: string
Returns void

eventNames

eventNames(): (string | symbol)[]

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

Private executeStats

executeStats(): void

- Defined in src/sharding/Admiral.ts:2554
Returns void

Private fetchInfo

fetchInfo(op: string, id: string | number, requestWorker: FakeWorker): void

- Defined in src/sharding/Admiral.ts:2529
Parameters
- op: string
- id: string | number
- requestWorker: FakeWorker
Returns void

getMaxListeners

getMaxListeners(): number

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

info

info(message: unknown, source?: string): void

- Defined in src/sharding/Admiral.ts:2689
Parameters
- message: unknown
- Optional source: string
Returns void

Private ipcLog

ipcLog(type: "log" | "info" | "error" | "warn" | "debug", message: unknown, worker: FakeWorker): void

- Defined in src/sharding/Admiral.ts:2602
Parameters
- type: "log" | "info" | "error" | "warn" | "debug"
- message: unknown
- worker: FakeWorker
Returns void

Private ipcMessageHandler

ipcMessageHandler(worker: FakeWorker, message: any): void

- Defined in src/sharding/Admiral.ts:994
Parameters
- worker: FakeWorker
- message: any
Returns void

Private ipcReturn

ipcReturn(message: { UUID: string | number; value: { id: string | symbol; noValue?: boolean; value: any } }): void

- Defined in src/sharding/Admiral.ts:1624
Parameters
- message: { UUID: string | number; value: { id: string | symbol; noValue?: boolean; value: any } }
  - UUID: string | number
  - value: { id: string | symbol; noValue?: boolean; value: any }
    - id: string | symbol
    - Optional noValue?: boolean
    - value: any
Returns void

Private launch

launch(): void

- Defined in src/sharding/Admiral.ts:1549
Returns void

listenerCount

listenerCount(event: string | symbol): number

Inherited from EventEmitter.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 EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
Returns Function[]

log

log(message: unknown, source?: string): void

- Defined in src/sharding/Admiral.ts:2685
Parameters
- message: unknown
- Optional source: string
Returns void

off

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

Inherited from EventEmitter.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 Fleet

on

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

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

once

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

Inherited from EventEmitter.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 Fleet

prependListener

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

Inherited from EventEmitter.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 Fleet

prependOnceListener

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

Inherited from EventEmitter.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 Fleet

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): Fleet

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- Optional event: string | symbol
Returns Fleet

removeListener

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

Inherited from EventEmitter.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 Fleet

reshard

reshard(options?: ReshardOptions): void

- Defined in src/sharding/Admiral.ts:1933
Reshards all clusters

Parameters
- Optional options: ReshardOptions
  
  Change the resharding options
Returns void

restartAllClusters

restartAllClusters(hard: boolean): void

- Defined in src/sharding/Admiral.ts:1718
Restarts all clusters

Parameters
- hard: boolean
  
  Whether to ignore the soft shutdown function
Returns void

restartAllServices

restartAllServices(hard: boolean): void

- Defined in src/sharding/Admiral.ts:1758
Restarts all services

Parameters
- hard: boolean
  
  Whether to ignore the soft shutdown function
Returns void

restartCluster

restartCluster(clusterID: number, hard: boolean): void

- Defined in src/sharding/Admiral.ts:1703
Restarts a specific cluster

Parameters
- clusterID: number
  
  ID of the cluster to restart
- hard: boolean
  
  Whether to ignore the soft shutdown function
Returns void

restartService

restartService(serviceName: string, hard: boolean): void

- Defined in src/sharding/Admiral.ts:1743
Restarts a specific service

Parameters
- serviceName: string
  
  Name of the service
- hard: boolean
  
  Whether to ignore the soft shutdown function
Returns void

Private restartWorker

restartWorker(worker: Worker, manual?: boolean, soft?: boolean): undefined | { message: { clientOptions: ClientOptions; clusterCount: number; clusterID: number; firstShardID: number; lastShardID: number; loadClusterCodeImmediately: boolean; op: string; path: undefined | string; resharding: boolean; serviceName: undefined; shardCount: number; startingStatus: undefined | StartingStatus; timeout: undefined; token: string; useCentralRequestHandler: boolean; whatToLog: LoggingOptions[] }; type: string; workerID: number } | { message: { clientOptions: undefined; clusterCount: undefined; clusterID: undefined; firstShardID: undefined; lastShardID: undefined; loadClusterCodeImmediately: undefined; op: string; path: undefined | string; resharding: undefined; serviceName: string; shardCount: undefined; startingStatus: undefined; timeout: number; token: undefined; useCentralRequestHandler: undefined; whatToLog: LoggingOptions[] }; type: string; workerID: number }

- Defined in src/sharding/Admiral.ts:2359
Parameters
- worker: Worker
- Optional manual: boolean
- Optional soft: boolean
Returns undefined | { message: { clientOptions: ClientOptions; clusterCount: number; clusterID: number; firstShardID: number; lastShardID: number; loadClusterCodeImmediately: boolean; op: string; path: undefined | string; resharding: boolean; serviceName: undefined; shardCount: number; startingStatus: undefined | StartingStatus; timeout: undefined; token: string; useCentralRequestHandler: boolean; whatToLog: LoggingOptions[] }; type: string; workerID: number } | { message: { clientOptions: undefined; clusterCount: undefined; clusterID: undefined; firstShardID: undefined; lastShardID: undefined; loadClusterCodeImmediately: undefined; op: string; path: undefined | string; resharding: undefined; serviceName: string; shardCount: undefined; startingStatus: undefined; timeout: number; token: undefined; useCentralRequestHandler: undefined; whatToLog: LoggingOptions[] }; type: string; workerID: number }

setMaxListeners

setMaxListeners(n: number): Fleet

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

shutdownCluster

shutdownCluster(clusterID: number, hard: boolean): void

- Defined in src/sharding/Admiral.ts:1788
Shuts down a cluster

Parameters
- clusterID: number
  
  The ID of the cluster to shutdown
- hard: boolean
  
  Whether to ignore the soft shutdown function
Returns void

shutdownService

shutdownService(serviceName: string, hard: boolean): void

- Defined in src/sharding/Admiral.ts:1804
Shuts down a service

Parameters
- serviceName: string
  
  The name of the service
- hard: boolean
  
  Whether to ignore the soft shutdown function
Returns void

Private shutdownWorker

shutdownWorker(worker: Worker, soft?: boolean, callback?: () => void, customMaps?: { clusters?: Collection<number, ClusterCollection>; launchingWorkers?: Collection<number, WorkerCollection>; services?: Collection<string, ServiceCollection> }): { message: { op: string }; type: string; workerID: number }

- Defined in src/sharding/Admiral.ts:2233
Parameters
- worker: Worker
- Optional soft: boolean
- Optional callback: () => void
  - - (): void
    - Returns void
- Optional customMaps: { clusters?: Collection<number, ClusterCollection>; launchingWorkers?: Collection<number, WorkerCollection>; services?: Collection<string, ServiceCollection> }
  - Optional clusters?: Collection<number, ClusterCollection>
  - Optional launchingWorkers?: Collection<number, WorkerCollection>
  - Optional services?: Collection<string, ServiceCollection>
Returns { message: { op: string }; type: string; workerID: number }
- message: { op: string }
  - op: string
- type: string
- workerID: number

Private startCluster

startCluster(): void

- Defined in src/sharding/Admiral.ts:2100
Returns void

Private startService

startService(servicesToStart?: ServiceCreator[], onlyServices?: boolean): Promise<void>

- Defined in src/sharding/Admiral.ts:2050
Parameters
- Optional servicesToStart: ServiceCreator[]
- Optional onlyServices: boolean
Returns Promise<void>

Private startStats

startStats(): void

- Defined in src/sharding/Admiral.ts:2588
Returns void

totalShutdown

totalShutdown(hard: boolean): void

- Defined in src/sharding/Admiral.ts:1855
Shuts down everything and exits the master process

Parameters
- hard: boolean
  
  Whether to ignore the soft shutdown function
Returns void

updateBotWorker

updateBotWorker(BotWorker: typeof BaseClusterWorker): void

- Defined in src/sharding/Admiral.ts:2046
Updates the BotWorker used by eris-fleet. The new class will be used the next time clusters are restarted.

Parameters
- BotWorker: typeof BaseClusterWorker
  
  BotWorker class to update with
Returns void

warn

warn(message: unknown, source?: string): void

- Defined in src/sharding/Admiral.ts:2693
Parameters
- message: unknown
- Optional source: string
Returns void

Static listenerCount

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

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: Options

Returns Fleet

Properties

Optional BotWorker

Private broadcastAdmiralEvents

centralStore

Private Optional chunks

Private clientOptions

clusterCount

clusterTimeout

clusters

Private clustersSequentialFailedRestarts

Private collectingStats

Private connectedClusterGroups

eris

Private erisClient

Private fetchTimeout

Private fetches

firstShardID

guildsPerShard

ipc

killTimeout

lastShardID

Private launchingManager

Private launchingWorkers

Private loadClusterCodeImmediately

Private maxConcurrency

Private Optional maxConcurrencyOverride

Private maxRestarts

Private Optional nodeArgs

Private objectLogging

Private overrideConsole

Optional path

Private pauseStats

Private Optional prelimStats

Private queue

Private resharding

serviceTimeout

services

Private servicesSequentialFailedRestarts

Private Optional servicesToCreate

shardCount

Private shutdownTogether

Private softKills

Private startServicesTogether

Private Optional startingStatus

Optional stats

Private statsInterval

Private statsStarted

Private Optional statsWorkersCounted

Private token

Private useCentralRequestHandler

Private whatToLog

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Fleet

broadcast

Parameters

op: string

Optional msg: unknown

Returns void

Private calculateShards