Class TopologyDescription

Representation of a deployment of servers

Hierarchy

TopologyDescription

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TopologyDescription(topologyType: TopologyType, serverDescriptions?: Map<string, ServerDescription>, setName?: string, maxSetVersion?: number, maxElectionId?: ObjectId, commonWireVersion?: number, options?: TopologyDescriptionOptions): TopologyDescription

- Defined in src/sdam/topology_description.ts:50
Create a TopologyDescription

Parameters
- topologyType: TopologyType
- Optional serverDescriptions: Map<string, ServerDescription>
- Optional setName: string
- Optional maxSetVersion: number
- Optional maxElectionId: ObjectId
- Optional commonWireVersion: number
- Optional options: TopologyDescriptionOptions
Returns TopologyDescription

Properties

Optional commonWireVersion

commonWireVersion?: number

Optional compatibilityError

compatibilityError?: string

compatible

compatible: boolean

heartbeatFrequencyMS

heartbeatFrequencyMS: number

localThresholdMS

localThresholdMS: number

Optional logicalSessionTimeoutMinutes

logicalSessionTimeoutMinutes?: number

Optional maxElectionId

maxElectionId?: ObjectId

Optional maxSetVersion

maxSetVersion?: number

servers

servers: Map<string, ServerDescription>

Optional setName

setName?: string

stale

stale: boolean

type

type: TopologyType

Accessors

error

get error(): undefined | MongoError

- Defined in src/sdam/topology_description.ts:316
Returns undefined | MongoError

hasDataBearingServers

get hasDataBearingServers(): boolean

- Defined in src/sdam/topology_description.ts:338
Determines if this topology description has a data-bearing server available.

Returns boolean

hasKnownServers

get hasKnownServers(): boolean

- Defined in src/sdam/topology_description.ts:329
Determines if the topology description has any known servers

Returns boolean

Methods

hasServer

hasServer(address: string): boolean

- Defined in src/sdam/topology_description.ts:346
Determines if the topology has a definition for the provided address

Parameters
- address: string
Returns boolean

update

update(serverDescription: ServerDescription): TopologyDescription

- Defined in src/sdam/topology_description.ts:200
Returns a copy of this description updated with a given ServerDescription

Parameters
- serverDescription: ServerDescription
Returns TopologyDescription

updateFromSrvPollingEvent

updateFromSrvPollingEvent(ev: SrvPollingEvent, srvMaxHosts?: number): TopologyDescription

- Defined in src/sdam/topology_description.ts:143
Returns a new TopologyDescription based on the SrvPollingEvent

Parameters
- ev: SrvPollingEvent
- srvMaxHosts: number = 0
Returns TopologyDescription

Generated using TypeDoc