IPC | eris-fleet

Handles communication between clusters, services, and the admiral.

Hierarchy

EventEmitter
- IPC

Properties

centralStore

centralStore: CentralStore

Private events

events: Map<string | number, ((msg: any) => void)[]>

Private fetchTimeout

fetchTimeout: number

Private ipcEventListeners

ipcEventListeners: Map<string | number, ((msg: any) => void)[]>

Private Optional messageHandler

messageHandler?: (message: any) => void

Type declaration

- (message: any): void
- Parameters
  - message: any
  Returns void

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): IPC

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 IPC

admiralBroadcast

admiralBroadcast(op: string, message?: unknown): void

- Defined in src/util/IPC.ts:353
deprecated
Use IPC.sendToAdmiral

Parameters
- op: string
- Optional message: unknown
Returns void

allClustersCommand

allClustersCommand(message?: unknown, receptive?: boolean, returnTimeout?: number, callback?: (clusterID: number, data?: any) => void): void | Promise<Map<number, any>>

- Defined in src/util/IPC.ts:592
Execute a cluster command on all clusters
example
```
this.ipc.allClustersCommand("hello clusters!", true, undefined, (id, data) => {
    console.log(`I just received ${data} from ${id}!`);
})
.then((data) => this.ipc.log(`All my clusters responded and my data in a map. Here is the data from cluster 0: ${data.get(0)}`))
.catch((error) => this.ipc.error(error));
```
Parameters
- Optional message: unknown
  
  Whatever message you want to send with the command (defaults to null)
- Optional receptive: boolean
  
  Whether you expect something to be returned to you from the command (defaults to false)
- Optional returnTimeout: number
  
  How long to wait for a return (defaults to options.fetchTimeout)
- Optional callback: (clusterID: number, data?: any) => void
  
  Function which will be run everytime a new command return is received
  - - (clusterID: number, data?: any): void
    - Parameters
      - clusterID: number
      - Optional data: any
      Returns void
Returns void | Promise<Map<number, any>>
Promise which provides a map with the data replied mapped by cluster ID if receptive = true

allClustersEval

allClustersEval(stringToEvaluate: string, receptive?: boolean, returnTimeout?: number, callback?: (clusterID: number, data?: any) => void): void | Promise<Map<number, any>>

- Defined in src/util/IPC.ts:885
Sends an eval to all clusters. The eval occurs from a function within the BaseClusterWorker class. NOTE: Use evals sparingly as they are a major security risk
example
```
this.ipc.allClustersCommand("return 'heyo!'", true, undefined, (id, data) => {
    console.log(`I just received ${data} from ${id}!`);
})
.then((data) => this.ipc.log(`All my clusters responded and my data in a map. Here is the data from cluster 0: ${data.get(0)}`))
.catch((error) => this.ipc.error(error));
```
Parameters
- stringToEvaluate: string
  
  String to send to eval
- Optional receptive: boolean
  
  Whether you expect something to be returned to you from the command (defaults to false)
- Optional returnTimeout: number
  
  How long to wait for a return (defaults to options.fetchTimeout)
- Optional callback: (clusterID: number, data?: any) => void
  
  Function which will be run everytime a new command return is received
  - - (clusterID: number, data?: any): void
    - Parameters
      - clusterID: number
      - Optional data: any
      Returns void
Returns void | Promise<Map<number, any>>
Promise which provides a map with the data replied mapped by cluster ID if receptive = true

broadcast

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

- Defined in src/util/IPC.ts:330
Broadcast an event to all clusters and services. The event can be listened to with register
example
```
this.ipc.broadcast("hello clusters!", "Want to chat?");
```
Parameters
- op: string
  
  Name of the event
- Optional message: unknown
  
  Message to send
Returns void

clusterCommand

clusterCommand(clusterID: string, message?: unknown, receptive?: boolean, returnTimeout?: number): void | Promise<any>

- Defined in src/util/IPC.ts:529
Execute a cluster command
example
```
this.ipc.clusterCommand(1, "hello cluster!", true)
.then((message) => console.log(message))
.catch((error) => this.ipc.error(error));
```
Parameters
- clusterID: string
  
  ID of the cluster
- Optional message: unknown
  
  Whatever message you want to send with the command (defaults to null)
- Optional receptive: boolean
  
  Whether you expect something to be returned to you from the command (defaults to false)
- Optional returnTimeout: number
  
  How long to wait for a return (defaults to options.fetchTimeout)
Returns void | Promise<any>
Promise with data if receptive = true

clusterEval

clusterEval(clusterID: number, stringToEvaluate: string, receptive?: boolean, returnTimeout?: number): void | Promise<any>

- Defined in src/util/IPC.ts:822
Sends an eval to the mentioned cluster. The eval occurs from a function within the BaseClusterWorker class. NOTE: Use evals sparingly as they are a major security risk
example
```
this.ipc.clusterEval(1, "return 'hey!'", true)
.then((data) => this.ipc.log(data))
.catch((error) => this.ipc.error(error));
```
Parameters
- clusterID: number
  
  ID of the cluster
- stringToEvaluate: string
  
  String to send to eval
- Optional receptive: boolean
  
  Whether you expect something to be returned to you from the command (defaults to false)
- Optional returnTimeout: number
  
  How long to wait for a return (defaults to options.fetchTimeout)
Returns void | Promise<any>
Promise with result if receptive = true

collectStats

collectStats(): Promise<Stats>

- Defined in src/util/IPC.ts:683
Force eris-fleet to fetch fresh stats

Returns Promise<Stats>
Promise with stats

command

command(service: string, message?: unknown, receptive?: boolean, returnTimeout?: number): void | Promise<any>

- Defined in src/util/IPC.ts:451
deprecated
Use IPC.serviceCommand

Parameters
- service: string
- Optional message: unknown
- Optional receptive: boolean
- Optional returnTimeout: number
Returns void | Promise<any>

createService

createService(serviceName: string, servicePath: string): Promise<undefined | ServiceCollection>

- Defined in src/util/IPC.ts:772
Create a service
example
```
const path = require("path");
this.ipc.createService("myService", path.join(__dirname, "./service.js"))
```
Parameters
- serviceName: string
  
  Unique ame of the service
- servicePath: string
  
  Absolute path to the service file
Returns Promise<undefined | ServiceCollection>
Promise which resolves with the service object when it is ready

debug

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

- Defined in src/util/IPC.ts:270
Sends a debug log to the Admiral
example
```
this.ipc.debug("I'm here!");
```
Parameters
- message: unknown
  
  Item to log
- Optional source: string
  
  Custom error source
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

error

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

- Defined in src/util/IPC.ts:244
Sends an error log to the Admiral
example
```
this.ipc.error(new Error("big yikes"));
```
Parameters
- message: unknown
  
  Item to log
- Optional source: string
  
  Custom error source
Returns void

eventNames

eventNames(): (string | symbol)[]

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

fetchChannel

fetchChannel(id: string): Promise<any>

- Defined in src/util/IPC.ts:418
Fetch a cached channel from the Eris client on any cluster
example
```
await this.ipc.fetchChannel('123456789');
```
Parameters
- id: string
  
  Channel ID
Returns Promise<any>
The Eris channel object converted to JSON

fetchGuild

fetchGuild(id: string): Promise<any>

- Defined in src/util/IPC.ts:400
Fetch a cached guild from the Eris client on any cluster
example
```
await this.ipc.fetchGuild('123456789');
```
Parameters
- id: string
  
  Guild ID
Returns Promise<any>
The Eris guild object converted to JSON

fetchMember

fetchMember(guildID: string, memberID: string): Promise<any>

- Defined in src/util/IPC.ts:437
Fetch a cached member from the Eris client on any cluster
example
```
await this.ipc.fetchMember('123456789', '987654321');
```
Parameters
- guildID: string
  
  Guild ID
- memberID: string
  
  the member's user ID
Returns Promise<any>
The Eris member object converted to JSON

fetchUser

fetchUser(id: string): Promise<any>

- Defined in src/util/IPC.ts:382
Fetch a cached user from the Eris client on any cluster
example
```
await this.ipc.fetchUser('123456789');
```
Parameters
- id: string
  
  User ID
Returns Promise<any>
The Eris user object converted to JSON

getMaxListeners

getMaxListeners(): number

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

getStats

getStats(): Promise<Stats>

- Defined in src/util/IPC.ts:650
Returns Promise<Stats>
The latest stats

getWorkers

getWorkers(): Promise<{ clusters: Collection<number, ClusterCollection>; services: Collection<string, ServiceCollection> }>

- Defined in src/util/IPC.ts:664
Returns Promise<{ clusters: Collection<number, ClusterCollection>; services: Collection<string, ServiceCollection> }>
Collection of clusters and collection of services

info

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

- Defined in src/util/IPC.ts:231
Sends an info log to the Admiral
example
```
this.ipc.info("You might want to take a look at this");
```
Parameters
- message: unknown
  
  Item to log
- Optional source: string
  
  Custom error source
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/util/IPC.ts:218
Sends a log to the Admiral
example
```
this.ipc.log("You have reached this line of code");
```
Parameters
- message: unknown
  
  Item to log
- Optional source: string
  
  Custom error source
Returns void

off

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

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 IPC

on

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

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 IPC

once

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

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 IPC

prependListener

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

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 IPC

prependOnceListener

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

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 IPC

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[]

register

- Defined in src/util/IPC.ts:287
Register for an event. This will receive broadcasts and messages sent to this cluster. This will also receive Admiral events if broadcastAdmiralEvents is enabled in options. Events can be sent using sendTo and broadcast
example
```
this.ipc.register("hello!", (message) => {
    // Do stuff
    console.log(message);
});
```
Parameters
- event: string
  
  Name of the event
- callback: (msg: any) => void
  
  Function run when event is received
  - - (msg: any): void
    - Parameters
      - msg: any
      Returns void
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): IPC

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

removeListener

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

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 IPC

reshard

reshard(options?: ReshardOptions): Promise<void>

- Defined in src/util/IPC.ts:799
Reshards all clusters

Parameters
- Optional options: ReshardOptions
  
  Change the resharding options
Returns Promise<void>
Promise which resolves when resharding is complete (note that this only resolves when using a service or the Admiral)

restartAllClusters

restartAllClusters(hard?: boolean): void

- Defined in src/util/IPC.ts:710
Restarts all clusters

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

restartAllServices

restartAllServices(hard?: boolean): void

- Defined in src/util/IPC.ts:731
Restarts all services

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

restartCluster

restartCluster(clusterID: number, hard?: boolean): Promise<undefined | ClusterCollection>

- Defined in src/util/IPC.ts:699
Restarts a specific cluster

Parameters
- clusterID: number
  
  ID of the cluster to restart
- Optional hard: boolean
  
  Whether to ignore the soft shutdown function
Returns Promise<undefined | ClusterCollection>
Promise which resolves with the cluster object when it restarts

restartService

restartService(serviceName: string, hard?: boolean): Promise<undefined | ServiceCollection>

- Defined in src/util/IPC.ts:720
Restarts a specific service

Parameters
- serviceName: string
  
  Name of the service
- Optional hard: boolean
  
  Whether to ignore the soft shutdown function
Returns Promise<undefined | ServiceCollection>
Promise which resolves with the service object when it restarts

Private sendLog

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

- Defined in src/util/IPC.ts:190
Parameters
- type: "log" | "info" | "error" | "warn" | "debug"
- value: unknown
- Optional source: string
Returns void

sendTo

sendTo(cluster: number, op: string, message?: unknown): void

- Defined in src/util/IPC.ts:368
Send a message to a specific cluster. The event can be listened to with register
example
```
this.ipc.sendTo(1, "Hello cluster 1!", "Squad up?");
```
Parameters
- cluster: number
  
  ID of the cluster
- op: string
  
  Name of the event
- Optional message: unknown
  
  Message to send
Returns void

sendToAdmiral

sendToAdmiral(op: string, message?: unknown): void

- Defined in src/util/IPC.ts:345
Send to the master process. The event can be listened to using Admiral.on("event", listener);
example
```
this.ipc.sendToAdmiral("Hello", "I'm working!");
```
Parameters
- op: string
  
  Name of the event
- Optional message: unknown
  
  Message to send
Returns void

serviceCommand

serviceCommand(service: string, message?: unknown, receptive?: boolean, returnTimeout?: number): void | Promise<any>

- Defined in src/util/IPC.ts:469
Execute a service command
example
```
this.ipc.serviceCommand("ServiceName", "hello service!", true)
.then((message) => console.log(message))
.catch((error) => this.ipc.error(error));
```
Parameters
- service: string
  
  Name of the service
- Optional message: unknown
  
  Whatever message you want to send with the command (defaults to null)
- Optional receptive: boolean
  
  Whether you expect something to be returned to you from the command (defaults to false)
- Optional returnTimeout: number
  
  How long to wait for a return (defaults to options.fetchTimeout)
Returns void | Promise<any>
Promise with data if receptive = true

serviceEval

serviceEval(serviceName: string, stringToEvaluate: string, receptive?: boolean, returnTimeout?: number): void | Promise<any>

- Defined in src/util/IPC.ts:954
Sends an eval to the mentioned service. The eval occurs from a function within the BaseServiceWorker class. NOTE: Use evals sparingly as they are a major security risk
example
```
this.ipc.serviceEval(1, "return 'hey!'", true)
.then((data) => this.ipc.log(data))
.catch((error) => this.ipc.error(error));
```
Parameters
- serviceName: string
  
  Name of the service
- stringToEvaluate: string
  
  String to send to eval
- Optional receptive: boolean
  
  Whether you expect something to be returned to you from the command (defaults to false)
- Optional returnTimeout: number
  
  How long to wait for a return (defaults to options.fetchTimeout)
Returns void | Promise<any>
Promise with result if receptive = true

setMaxListeners

setMaxListeners(n: number): IPC

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

shutdownCluster

shutdownCluster(clusterID: number, hard?: boolean): Promise<undefined | ClusterCollection>

- Defined in src/util/IPC.ts:741
Shuts down a cluster

Parameters
- clusterID: number
  
  The ID of the cluster to shutdown
- Optional hard: boolean
  
  Whether to ignore the soft shutdown function
Returns Promise<undefined | ClusterCollection>
Promise which resolves with the cluster object when it shuts down

shutdownService

shutdownService(serviceName: string, hard?: boolean): Promise<undefined | ServiceCollection>

- Defined in src/util/IPC.ts:754
Shuts down a service

Parameters
- serviceName: string
  
  The name of the service
- Optional hard: boolean
  
  Whether to ignore the soft shutdown function
Returns Promise<undefined | ServiceCollection>
Promise which resolves with the service object when it shuts down

totalShutdown

totalShutdown(hard?: boolean): void

- Defined in src/util/IPC.ts:790
Shuts down everything and exits the master process

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

unregister

unregister(event: string, callback?: (msg: any) => void): void

- Defined in src/util/IPC.ts:305
Unregisters an event
example
```
this.ipc.unregister("stats");
```
Parameters
- event: string
  
  Name of the event
- Optional callback: (msg: any) => void
  
  Function which was listening. Leave empty if you want to delete all listeners registered to this event name.
  - - (msg: any): void
    - Parameters
      - msg: any
      Returns void
Returns void

warn

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

- Defined in src/util/IPC.ts:257
Sends a warn log to the Admiral
example
```
this.ipc.warn("uh oh!");
```
Parameters
- message: unknown
  
  Item to log
- Optional source: string
  
  Custom error source
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

Properties

Methods

Properties

centralStore

Private events

Private fetchTimeout

Private ipcEventListeners

Private Optional messageHandler

Type declaration

Parameters

message: any

Returns void

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 IPC

admiralBroadcast

Parameters

op: string

Optional message: unknown

Returns void

allClustersCommand

Parameters

Optional message: unknown

Optional receptive: boolean

Optional returnTimeout: number

Optional callback: (clusterID: number, data?: any) => void

Parameters

clusterID: number

Optional data: any

Returns void

Returns void | Promise<Map<number, any>>

allClustersEval

Parameters

stringToEvaluate: string

Optional receptive: boolean

Optional returnTimeout: number

Optional callback: (clusterID: number, data?: any) => void

Parameters

clusterID: number

Optional data: any

Returns void

Returns void | Promise<Map<number, any>>

broadcast

Parameters

op: string

Optional message: unknown

Returns void

clusterCommand

Parameters

clusterID: string

Optional message: unknown

Optional receptive: boolean

Optional returnTimeout: number

Returns void | Promise<any>

clusterEval

Parameters

clusterID: number

stringToEvaluate: string

Optional receptive: boolean

Optional returnTimeout: number

Returns void | Promise<any>

collectStats

Returns Promise<Stats>

command

Parameters

service: string

Optional message: unknown

Optional receptive: boolean