SrvPoller | mongodb

internal

Hierarchy

TypedEventEmitter<SrvPollerEvents>
- SrvPoller

Index

Constructors

constructor

Events

SRV_RECORD_DISCOVERY

Properties

Accessors

Constructors

constructor

new SrvPoller(options: SrvPollerOptions): SrvPoller

Overrides TypedEventEmitter.constructor
- Defined in src/sdam/srv_polling.ts:64
Parameters
- options: SrvPollerOptions
Returns SrvPoller

Events

Static Readonly SRV_RECORD_DISCOVERY

SRV_RECORD_DISCOVERY: "srvRecordDiscovery" = ...

Properties

Optional _timeout

_timeout: Timeout

generation

generation: number

haMode

haMode: boolean

heartbeatFrequencyMS

heartbeatFrequencyMS: number

logger

logger: Logger

rescanSrvIntervalMS

rescanSrvIntervalMS: number

srvHost

srvHost: string

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

intervalMS

get intervalMS(): number

- Defined in src/sdam/srv_polling.ts:88
Returns number

srvAddress

get srvAddress(): string

- Defined in src/sdam/srv_polling.ts:84
Returns string

Methods

_poll

_poll(): void

- Defined in src/sdam/srv_polling.ts:133
Returns void

addListener

addListener<EventKey>(event: EventKey, listener: SrvPollerEvents[EventKey]): SrvPoller
addListener(event: CommonEvents, listener: (eventName: string | symbol, listener: GenericListener) => void): SrvPoller
addListener(event: string | symbol, listener: GenericListener): SrvPoller

Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:342
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: EventKey
- listener: SrvPollerEvents[EventKey]
Returns SrvPoller
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 SrvPoller
Inherited from TypedEventEmitter.addListener
- Defined in src/mongo_types.ts:347
Parameters
- event: string | symbol
- listener: GenericListener
Returns SrvPoller

emit

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

Inherited from TypedEventEmitter.emit
- Defined in src/mongo_types.ts:389
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: symbol | EventKey
- Rest ...args: Parameters<SrvPollerEvents[EventKey]>
Returns boolean

eventNames

eventNames(): string[]

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

failure

failure(message: string, obj?: ErrnoException): void

- Defined in src/sdam/srv_polling.ts:120
Parameters
- message: string
- Optional obj: ErrnoException
Returns void

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: "srvRecordDiscovery"
Parameters
- type: string | symbol | EventKey
Returns number

listeners

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

Inherited from TypedEventEmitter.listeners
- Defined in src/mongo_types.ts:381
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: string | symbol | EventKey
Returns SrvPollerEvents[EventKey][]

off

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

Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:370
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: EventKey
- listener: SrvPollerEvents[EventKey]
Returns SrvPoller
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 SrvPoller
Inherited from TypedEventEmitter.off
- Defined in src/mongo_types.ts:375
Parameters
- event: string | symbol
- listener: GenericListener
Returns SrvPoller

on

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

Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:349
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: EventKey
- listener: SrvPollerEvents[EventKey]
Returns SrvPoller
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 SrvPoller
Inherited from TypedEventEmitter.on
- Defined in src/mongo_types.ts:354
Parameters
- event: string | symbol
- listener: GenericListener
Returns SrvPoller

once

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

Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:356
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: EventKey
- listener: SrvPollerEvents[EventKey]
Returns SrvPoller
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 SrvPoller
Inherited from TypedEventEmitter.once
- Defined in src/mongo_types.ts:361
Parameters
- event: string | symbol
- listener: GenericListener
Returns SrvPoller

parentDomainMismatch

parentDomainMismatch(srvRecord: SrvRecord): void

- Defined in src/sdam/srv_polling.ts:126
Parameters
- srvRecord: SrvRecord
Returns void

prependListener

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

Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:398
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: EventKey
- listener: SrvPollerEvents[EventKey]
Returns SrvPoller
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 SrvPoller
Inherited from TypedEventEmitter.prependListener
- Defined in src/mongo_types.ts:403
Parameters
- event: string | symbol
- listener: GenericListener
Returns SrvPoller

prependOnceListener

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

Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:405
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: EventKey
- listener: SrvPollerEvents[EventKey]
Returns SrvPoller
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 SrvPoller
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/mongo_types.ts:413
Parameters
- event: string | symbol
- listener: GenericListener
Returns SrvPoller

rawListeners

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

Inherited from TypedEventEmitter.rawListeners
- Defined in src/mongo_types.ts:385
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: string | symbol | EventKey
Returns SrvPollerEvents[EventKey][]

removeAllListeners

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

Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/mongo_types.ts:377
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- Optional event: string | symbol | EventKey
Returns SrvPoller

removeListener

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

Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:363
Type parameters
- EventKey: "srvRecordDiscovery"
Parameters
- event: EventKey
- listener: SrvPollerEvents[EventKey]
Returns SrvPoller
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 SrvPoller
Inherited from TypedEventEmitter.removeListener
- Defined in src/mongo_types.ts:368
Parameters
- event: string | symbol
- listener: GenericListener
Returns SrvPoller

schedule

schedule(): void

- Defined in src/sdam/srv_polling.ts:106
Returns void

setMaxListeners

setMaxListeners(n: number): SrvPoller

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

start

start(): void

- Defined in src/sdam/srv_polling.ts:92
Returns void

stop

stop(): void

- Defined in src/sdam/srv_polling.ts:98
Returns void

success

success(srvRecords: SrvRecord[]): void

- Defined in src/sdam/srv_polling.ts:114
Parameters
- srvRecords: SrvRecord[]
Returns void

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

Events

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: SrvPollerOptions

Returns SrvPoller

Events

Static Readonly SRV_RECORD_DISCOVERY

Properties

Optional _timeout

generation

haMode

heartbeatFrequencyMS

logger

rescanSrvIntervalMS

srvHost

Static Readonly captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

intervalMS

Returns number

srvAddress

Returns string

Methods

_poll

Returns void

addListener

Type parameters

EventKey: "srvRecordDiscovery"

Parameters

event: EventKey

listener: SrvPollerEvents[EventKey]

Returns SrvPoller

Parameters

event: CommonEvents

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

Parameters

eventName: string | symbol

listener: GenericListener

Returns void

Returns SrvPoller

Parameters

event: string | symbol

listener: GenericListener

Returns SrvPoller

emit

Type parameters

EventKey: "srvRecordDiscovery"

Parameters

event: symbol | EventKey

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

Returns boolean

eventNames

Returns string[]

failure

Parameters

message: string

Optional obj: ErrnoException

Returns void

getMaxListeners

Returns number

listenerCount

Type parameters

EventKey: "srvRecordDiscovery"

Parameters

type: string | symbol | EventKey

Returns number

listeners

Type parameters

EventKey: "srvRecordDiscovery"

Parameters

event: string | symbol | EventKey