Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Topology

A container of server instances representing a connection to a MongoDB topology.

Hierarchy

Index

Constructors

constructor

Events

Static Readonly CLOSE

CLOSE: "close" = CLOSE

Static Readonly CONNECT

CONNECT: "connect" = CONNECT

Static Readonly ERROR

ERROR: "error" = ERROR

Static Readonly OPEN

OPEN: "open" = OPEN

Static Readonly SERVER_CLOSED

SERVER_CLOSED: "serverClosed" = SERVER_CLOSED

Static Readonly SERVER_DESCRIPTION_CHANGED

SERVER_DESCRIPTION_CHANGED: "serverDescriptionChanged" = SERVER_DESCRIPTION_CHANGED

Static Readonly SERVER_OPENING

SERVER_OPENING: "serverOpening" = SERVER_OPENING

Static Readonly TIMEOUT

TIMEOUT: "timeout" = TIMEOUT

Static Readonly TOPOLOGY_CLOSED

TOPOLOGY_CLOSED: "topologyClosed" = TOPOLOGY_CLOSED

Static Readonly TOPOLOGY_DESCRIPTION_CHANGED

TOPOLOGY_DESCRIPTION_CHANGED: "topologyDescriptionChanged" = TOPOLOGY_DESCRIPTION_CHANGED

Static Readonly TOPOLOGY_OPENING

TOPOLOGY_OPENING: "topologyOpening" = TOPOLOGY_OPENING

Properties

[kWaitQueue]

[kWaitQueue]: Denque<ServerSelectionRequest>

Optional _type

_type?: string

bson

bson: { deserialize: (buffer: Buffer | ArrayBufferView | ArrayBuffer, options?: DeserializeOptions) => Document; serialize: (object: Document, options?: SerializeOptions) => Buffer }
privateremarks

mongodb-client-encryption's class ClientEncryption falls back to finding the bson lib defined on client.topology.bson, in order to maintain compatibility with any version of mongodb-client-encryption we keep a reference to serialize and deserialize here.

Type declaration

  • deserialize: (buffer: Buffer | ArrayBufferView | ArrayBuffer, options?: DeserializeOptions) => Document
      • (buffer: Buffer | ArrayBufferView | ArrayBuffer, options?: DeserializeOptions): Document
      • Deserialize data as BSON.

        Parameters

        • buffer: Buffer | ArrayBufferView | ArrayBuffer

          the buffer containing the serialized set of BSON documents.

        • Optional options: DeserializeOptions

        Returns Document

        returns the deserialized Javascript Object.

  • serialize: (object: Document, options?: SerializeOptions) => Buffer
      • (object: Document, options?: SerializeOptions): Buffer
      • Serialize a Javascript object.

        Parameters

        • object: Document

          the Javascript object to serialize.

        • Optional options: SerializeOptions

        Returns Buffer

        Buffer object containing the serialized object.

Optional ismaster

ismaster?: Document

s

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

capabilities

clientMetadata

clusterTime

commonWireVersion

  • get commonWireVersion(): undefined | number

description

loadBalanced

  • get loadBalanced(): boolean

logicalSessionTimeoutMinutes

  • get logicalSessionTimeoutMinutes(): undefined | number

Methods

addListener

auth

close

connect

Private detectShardedTopology

Private detectSrvRecords

emit

  • emit<EventKey>(event: symbol | EventKey, ...args: Parameters<TopologyEvents[EventKey]>): boolean
  • Type parameters

    • EventKey: "closed" | "error" | keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "timeout" | "open"

    Parameters

    • event: symbol | EventKey
    • Rest ...args: Parameters<TopologyEvents[EventKey]>

    Returns boolean

endSessions

eventNames

  • eventNames(): string[]

getMaxListeners

  • getMaxListeners(): number

hasSessionSupport

  • hasSessionSupport(): boolean

isConnected

  • isConnected(): boolean

isDestroyed

  • isDestroyed(): boolean

lastIsMaster

listenerCount

  • listenerCount<EventKey>(type: string | symbol | EventKey): number
  • Type parameters

    • EventKey: "closed" | "error" | keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "timeout" | "open"

    Parameters

    • type: string | symbol | EventKey

    Returns number

listeners

  • listeners<EventKey>(event: string | symbol | EventKey): TopologyEvents[EventKey][]
  • Type parameters

    • EventKey: "closed" | "error" | keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "timeout" | "open"

    Parameters

    • event: string | symbol | EventKey

    Returns TopologyEvents[EventKey][]

off

on

once

prependListener

prependOnceListener

rawListeners

  • rawListeners<EventKey>(event: string | symbol | EventKey): TopologyEvents[EventKey][]
  • Type parameters

    • EventKey: "closed" | "error" | keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "timeout" | "open"

    Parameters

    • event: string | symbol | EventKey

    Returns TopologyEvents[EventKey][]

removeAllListeners

  • removeAllListeners<EventKey>(event?: string | symbol | EventKey): Topology
  • Type parameters

    • EventKey: "closed" | "error" | keyof ConnectionEvents | "connect" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "descriptionReceived" | "ended" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "stateChanged" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "timeout" | "open"

    Parameters

    • Optional event: string | symbol | EventKey

    Returns Topology

removeListener

selectServer

serverUpdateHandler

  • Update the internal TopologyDescription with a ServerDescription

    Parameters

    • serverDescription: ServerDescription

      The server to update in the internal list of server descriptions

    Returns void

setMaxListeners

shouldCheckForSessionSupport

  • shouldCheckForSessionSupport(): boolean
  • Returns boolean

    Whether the topology should initiate selection to determine session support

startSession

unref

  • unref(): void
  • deprecated

    This function is deprecated and will be removed in the next major version.

    Returns void

Static getEventListeners

  • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
  • 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

    Parameters

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

    Returns Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, eventName: string | symbol): number
  • 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

Static on

  • on(emitter: EventEmitter, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • ```js 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:

    ```js
    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

Static once

  • once(emitter: NodeEventTarget, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • 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[]>

Generated using TypeDoc