Class Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

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 Object.

Fires

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

Fires

Admiral#serviceShutdown Fires when a service is shutdown. Supplies 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.

Type Parameters

  • LibClient

  • LibClientType

  • LibClientOptions

  • LibLatencyRef

  • LibClientStatus

Hierarchy

  • EventEmitter
    • Admiral

Constructors

  • Creates the sharding manager

    Type Parameters

    • LibClient

    • LibClientType

    • LibClientOptions

    • LibLatencyRef

    • LibClientStatus

    Parameters

    • options: Options<LibClientType, LibClientOptions, LibClientStatus, LibClient, LibLatencyRef>

      Options to configure the sharding manager

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

Properties

BotWorker?: typeof BaseClusterWorker

BotWorker class used when starting clusters

bot?: LibClient

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

broadcastAdmiralEvents: boolean
centralStore: Map<string, any>

Central storage map

chunks?: number[][]
clusterCount: number | "auto"
clusterTimeout: number
clusters: Collection<number, ClusterCollection>

Map of clusters by ID

clustersSequentialFailedRestarts: Map<number, number>

Map of cluster ID to sequential failed restarts

collectingStats: boolean
connectedClusterGroups: Map<number, number>

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

fetchTimeout: number
fetches: Map<string, {
    UUID: number | "master";
    checked: number;
    id: string | number;
    op: string;
}>
firstShardID: number
guildsPerShard: number | "auto"
ipc: IPC<LibLatencyRef>

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

killTimeout: number
lastShardID: number
launchingManager: Map<number, "launched" | {
    waiting: (() => void);
}>
launchingWorkers: Collection<number, WorkerCollection>

Maps of workers currently launching by ID

loadClusterCodeImmediately: boolean
maxConcurrency: number
maxConcurrencyOverride?: number
maxRestarts: number
nodeArgs?: string[]
objectLogging: boolean
overrideConsole: boolean
path?: string

Path used when starting clusters

pauseStats: boolean
prelimStats?: Stats<LibLatencyRef>
queue: Queue
resharding: boolean
serviceTimeout: number
services: Collection<string, ServiceCollection>

Map of services by name

servicesSequentialFailedRestarts: Map<string, number>

Map of service name to sequential failed restarts

servicesToCreate?: ServiceCreator<LibLatencyRef>[]

Services to create

shardCount: number | "auto"
shutdownTogether: boolean
softKillNotificationPeriod: number
softKills: Map<number, {
    fn: ((failed?) => void);
    id?: string | number;
    type?: "service" | "cluster";
}>
startServicesTogether: boolean
startingStatus?: LibClientStatus
stats?: Stats<LibLatencyRef>

Current stats

statsInterval: number | "disable"
statsStarted: boolean
statsWorkersCounted?: number
useCentralRequestHandler: boolean
whatToLog: LoggingOptions[]
captureRejectionSymbol: typeof captureRejectionSymbol
captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

defaultMaxListeners: number
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

  • Alias for emitter.on(eventName, listener).

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

  • 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

  • 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

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
    console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
    console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
    const parameters = args.join(', ');
    console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    // [Function: firstListener],
    // [Function: secondListener],
    // [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]

    Since

    v6.0.0

    Returns (string | symbol)[]

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Since

    v1.0.0

    Returns number

  • 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

  • Returns the number of listeners listening to the event named eventName.

    Since

    v3.2.0

    Parameters

    • eventName: string | symbol

      The name of the event being listened for

    Returns number

  • Returns a copy of the array of listeners for the event named eventName.

    server.on('connection', (stream) => {
    console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol

    Returns Function[]

  • Alias for emitter.removeListener().

    Since

    v10.0.0

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

  • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    server.on('connection', (stream) => {
    console.log('someone connected!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    // b
    // a

    Since

    v0.1.101

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args) => void)

      The callback function

        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

  • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

    server.once('connection', (stream) => {
    console.log('Ah, we have our first user!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    // b
    // a

    Since

    v0.3.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args) => void)

      The callback function

        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

  • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

    server.prependListener('connection', (stream) => {
    console.log('someone connected!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v6.0.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args) => void)

      The callback function

        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

  • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

    server.prependOnceListener('connection', (stream) => {
    console.log('Ah, we have our first user!');
    });

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v6.0.0

    Parameters

    • eventName: string | symbol

      The name of the event.

    • listener: ((...args) => void)

      The callback function

        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

  • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');

    Since

    v9.4.0

    Parameters

    • eventName: string | symbol

    Returns Function[]

  • Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v0.1.26

    Parameters

    • Optional event: string | symbol

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

  • Removes the specified listener from the listener array for the event namedeventName.

    const callback = (stream) => {
    console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);

    removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

    Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

    const myEmitter = new MyEmitter();

    const callbackA = () => {
    console.log('A');
    myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
    console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    // A
    // B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    // A

    Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

    When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

    const ee = new EventEmitter();

    function pong() {
    console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v0.1.26

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

  • Restarts a specific cluster

    Parameters

    • clusterID: number

      ID of the cluster to restart

    • hard: boolean

      Whether to ignore the soft shutdown function

    Returns void

  • Restarts a specific service

    Parameters

    • serviceName: string

      Name of the service

    • hard: boolean

      Whether to ignore the soft shutdown function

    Returns void

  • Parameters

    • worker: Worker
    • Optional manual: boolean
    • Optional soft: boolean

    Returns undefined | {
        message: {
            clientOptions: LibClientOptions;
            clusterCount: number;
            clusterID: number;
            firstShardID: number;
            lastShardID: number;
            loadClusterCodeImmediately: boolean;
            op: string;
            path: undefined | string;
            resharding: boolean;
            serviceName?: undefined;
            shardCount: number;
            startingStatus: undefined | LibClientStatus;
            timeout?: undefined;
            token: undefined | 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;
    }

  • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Since

    v0.3.5

    Parameters

    • n: number

    Returns Admiral<LibClient, LibClientType, LibClientOptions, LibLatencyRef, LibClientStatus>

  • 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

  • Shuts down a service

    Parameters

    • serviceName: string

      The name of the service

    • hard: boolean

      Whether to ignore the soft shutdown function

    Returns void

  • Parameters

    Returns {
        message: {
            op: string;
        };
        type: string;
        workerID: number;
    }

    • message: {
          op: string;
      }
      • op: string
    • type: string
    • workerID: number
  • Returns a copy of the array of listeners for the event named eventName.

    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

    For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

    const { getEventListeners, EventEmitter } = require('events');

    {
    const ee = new EventEmitter();
    const listener = () => console.log('Events are fun');
    ee.on('foo', listener);
    getEventListeners(ee, 'foo'); // [listener]
    }
    {
    const et = new EventTarget();
    const listener = () => console.log('Events are fun');
    et.addEventListener('foo', listener);
    getEventListeners(et, 'foo'); // [listener]
    }

    Since

    v15.2.0, v14.17.0

    Parameters

    • emitter: EventEmitter | _DOMEventTarget
    • name: string | symbol

    Returns Function[]

  • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2

    Since

    v0.9.12

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    Parameters

    • emitter: EventEmitter

      The emitter to query

    • eventName: string | symbol

      The event name

    Returns number

  • const { on, EventEmitter } = require('events');

    (async () => {
    const ee = new EventEmitter();

    // Emit later on
    process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
    });

    for await (const event of on(ee, 'foo')) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
    }
    // Unreachable here
    })();

    Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

    An AbortSignal can be used to cancel waiting on events:

    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
    const ee = new EventEmitter();

    // Emit later on
    process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
    });

    for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
    }
    // Unreachable here
    })();

    process.nextTick(() => ac.abort());

    Since

    v13.6.0, v12.16.0

    Parameters

    • emitter: EventEmitter
    • eventName: string

      The name of the event being listened for

    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

  • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

    const { once, EventEmitter } = require('events');

    async function run() {
    const ee = new EventEmitter();

    process.nextTick(() => {
    ee.emit('myevent', 42);
    });

    const [value] = await once(ee, 'myevent');
    console.log(value);

    const err = new Error('kaboom');
    process.nextTick(() => {
    ee.emit('error', err);
    });

    try {
    await once(ee, 'myevent');
    } catch (err) {
    console.log('error happened', err);
    }
    }

    run();

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
    .then(([err]) => console.log('ok', err.message))
    .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom

    An AbortSignal can be used to cancel waiting for the event:

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
    try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
    } catch (error) {
    if (error.name === 'AbortError') {
    console.error('Waiting for the event was canceled!');
    } else {
    console.error('There was an error', error.message);
    }
    }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!

    Since

    v11.13.0, v10.16.0

    Parameters

    • emitter: _NodeEventTarget
    • eventName: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: _DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • const {
    setMaxListeners,
    EventEmitter
    } = require('events');

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);

    Since

    v15.4.0

    Parameters

    • Optional n: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]

    Returns void

Generated using TypeDoc