Monitor | mongodb

internal

Hierarchy

TypedEventEmitter<MonitorEvents>
- Monitor

Index

Constructors

constructor

Properties

Constructors

constructor

new Monitor(server: Server, options: MonitorOptions): Monitor

Overrides TypedEventEmitter.constructor
- Defined in src/sdam/monitor.ts:89
Parameters
- server: Server
- options: MonitorOptions
Returns Monitor

Properties

[kCancellationToken]

[kCancellationToken]: CancellationToken

Optional [kConnection]

[kConnection]: Connection

Optional [kMonitorId]

[kMonitorId]: InterruptibleAsyncInterval

internal

Optional [kRTTPinger]

[kRTTPinger]: RTTPinger

[kServer]

[kServer]: Server

address

address: string

connectOptions

connectOptions: ConnectionOptions

options

options: Readonly<Pick<MonitorOptions, "connectTimeoutMS" | "minHeartbeatFrequencyMS" | "heartbeatFrequencyMS">>

s

s: MonitorPrivate

internal

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<EventKey>(event: EventKey, listener: MonitorEvents[EventKey]): Monitor
addListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Monitor
addListener(event: string | symbol, listener: GenericListener): Monitor

Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:342
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: EventKey
- listener: MonitorEvents[EventKey]
Returns Monitor
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:343
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns Monitor
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:347
Parameters
- event: string | symbol
- listener: GenericListener
Returns Monitor

close

close(): void

- Defined in src/sdam/monitor.ts:183
Returns void

connect

connect(): void

- Defined in src/sdam/monitor.ts:139
Returns void

emit

emit<EventKey>(event: symbol | EventKey, ...args: Parameters<MonitorEvents[EventKey]>): boolean

Inherited from TypedEventEmitter.emit
- Defined in src/mongo_types.ts:389
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<MonitorEvents[EventKey]>
Returns boolean

eventNames

eventNames(): string[]

Inherited from TypedEventEmitter.eventNames
- Defined in src/mongo_types.ts:415
Returns string[]

getMaxListeners

getMaxListeners(): number

Inherited from TypedEventEmitter.getMaxListeners
- Defined in src/mongo_types.ts:416
Returns number

listenerCount

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

Inherited from TypedEventEmitter.listenerCount
- Defined in src/mongo_types.ts:394
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- type: string | symbol | EventKey
Returns number

listeners

listeners<EventKey>(event: string | symbol | EventKey): MonitorEvents[EventKey][]

Inherited from TypedEventEmitter.listeners
- Defined in src/mongo_types.ts:381
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: string | symbol | EventKey
Returns MonitorEvents[EventKey][]

off

off<EventKey>(event: EventKey, listener: MonitorEvents[EventKey]): Monitor
off(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Monitor
off(event: string | symbol, listener: GenericListener): Monitor

Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:370
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: EventKey
- listener: MonitorEvents[EventKey]
Returns Monitor
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:371
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns Monitor
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:375
Parameters
- event: string | symbol
- listener: GenericListener
Returns Monitor

on

on<EventKey>(event: EventKey, listener: MonitorEvents[EventKey]): Monitor
on(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Monitor
on(event: string | symbol, listener: GenericListener): Monitor

Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:349
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: EventKey
- listener: MonitorEvents[EventKey]
Returns Monitor
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:350
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns Monitor
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:354
Parameters
- event: string | symbol
- listener: GenericListener
Returns Monitor

once

once<EventKey>(event: EventKey, listener: MonitorEvents[EventKey]): Monitor
once(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Monitor
once(event: string | symbol, listener: GenericListener): Monitor

Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:356
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: EventKey
- listener: MonitorEvents[EventKey]
Returns Monitor
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:357
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns Monitor
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:361
Parameters
- event: string | symbol
- listener: GenericListener
Returns Monitor

prependListener

prependListener<EventKey>(event: EventKey, listener: MonitorEvents[EventKey]): Monitor
prependListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Monitor
prependListener(event: string | symbol, listener: GenericListener): Monitor

Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:398
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: EventKey
- listener: MonitorEvents[EventKey]
Returns Monitor
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:399
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns Monitor
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:403
Parameters
- event: string | symbol
- listener: GenericListener
Returns Monitor

prependOnceListener

prependOnceListener<EventKey>(event: EventKey, listener: MonitorEvents[EventKey]): Monitor
prependOnceListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Monitor
prependOnceListener(event: string | symbol, listener: GenericListener): Monitor

Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:405
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: EventKey
- listener: MonitorEvents[EventKey]
Returns Monitor
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:409
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns Monitor
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:413
Parameters
- event: string | symbol
- listener: GenericListener
Returns Monitor

rawListeners

rawListeners<EventKey>(event: string | symbol | EventKey): MonitorEvents[EventKey][]

Inherited from TypedEventEmitter.rawListeners
- Defined in src/mongo_types.ts:385
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: string | symbol | EventKey
Returns MonitorEvents[EventKey][]

removeAllListeners

removeAllListeners<EventKey>(event?: string | symbol | EventKey): Monitor

Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/mongo_types.ts:377
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- Optional event: string | symbol | EventKey
Returns Monitor

removeListener

removeListener<EventKey>(event: EventKey, listener: MonitorEvents[EventKey]): Monitor
removeListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): Monitor
removeListener(event: string | symbol, listener: GenericListener): Monitor

Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:363
Type parameters
- EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"
Parameters
- event: EventKey
- listener: MonitorEvents[EventKey]
Returns Monitor
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:364
Parameters
- event: CommonEvents
- listener: (eventName: string | symbol, listener: GenericListener) => void
  - - (eventName: string | symbol, listener: GenericListener): void
    - Parameters
      - eventName: string | symbol
      - listener: GenericListener
      Returns void
Returns Monitor
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:368
Parameters
- event: string | symbol
- listener: GenericListener
Returns Monitor

requestCheck

requestCheck(): void

- Defined in src/sdam/monitor.ts:154
Returns void

reset

reset(): void

- Defined in src/sdam/monitor.ts:162
Returns void

setMaxListeners

setMaxListeners(n: number): Monitor

Inherited from TypedEventEmitter.setMaxListeners
- Defined in src/mongo_types.ts:417
Parameters
- n: number
Returns Monitor

Static getEventListener

getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

Inherited from TypedEventEmitter.getEventListener
- Defined in node_modules/@types/node/events.d.ts:34
Returns a list listener for a specific emitter event name.

Parameters
- emitter: DOMEventTarget | EventEmitter
- name: string | symbol
Returns Function[]

Static listenerCount

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

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

since v4.0.0

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

Static on

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

Inherited from TypedEventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: EventEmitter
- event: string
- Optional options: StaticEventEmitterOptions
Returns AsyncIterableIterator<any>

Static once

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

Inherited from TypedEventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- emitter: NodeEventTarget
- event: string | symbol
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Inherited from TypedEventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: DOMEventTarget
- event: string
- Optional options: StaticEventEmitterOptions
Returns Promise<any[]>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

server: Server

options: MonitorOptions

Returns Monitor

Properties

[kCancellationToken]

Optional [kConnection]

Optional [kMonitorId]

Optional [kRTTPinger]

[kServer]

address

connectOptions

options

s

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

addListener

Type parameters

EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"

Parameters

event: EventKey

listener: MonitorEvents[EventKey]

Returns Monitor

Parameters

event: CommonEvents

listener: (eventName: string | symbol, listener: GenericListener) => void

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns Monitor

Parameters

event: string | symbol

listener: GenericListener

Returns Monitor

close

Returns void

connect

Returns void

emit

Type parameters

EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"

Parameters

event: symbol | EventKey

Rest ...args: Parameters<MonitorEvents[EventKey]>

Returns boolean

eventNames

Returns string[]

getMaxListeners

Returns number

listenerCount

Type parameters

EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"

Parameters

type: string | symbol | EventKey

Returns number

listeners

Type parameters

EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"

Parameters

event: string | symbol | EventKey

Returns MonitorEvents[EventKey][]

off

Type parameters

EventKey: "close" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "stateChanged" | "resetServer" | "resetConnectionPool"

Parameters

event: EventKey

listener: MonitorEvents[EventKey]

Returns Monitor

Parameters