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:44
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:286
Returns undefined | MongoError

hasDataBearingServers

get hasDataBearingServers(): boolean

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

Returns boolean

hasKnownServers

get hasKnownServers(): boolean

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

Returns boolean

Methods

hasServer

hasServer(address: string): boolean

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

internal

Parameters
- address: string
Returns boolean

update

update(serverDescription: ServerDescription): TopologyDescription

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

internal

Parameters
- serverDescription: ServerDescription
Returns TopologyDescription

updateFromSrvPollingEvent

updateFromSrvPollingEvent(ev: SrvPollingEvent): TopologyDescription

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

internal

Parameters
- ev: SrvPollingEvent
Returns TopologyDescription

Generated using TypeDoc