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:49
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:292
~~Returns~~返回undefined | MongoError

hasDataBearingServers

get hasDataBearingServers(): boolean

- ~~Defined in~~ 定义位置：src/sdam/topology_description.ts:314
Determines if this topology description has a data-bearing server available.

~~Returns~~返回boolean

hasKnownServers

get hasKnownServers(): boolean

- ~~Defined in~~ 定义位置：src/sdam/topology_description.ts:305
Determines if the topology description has any known servers

~~Returns~~返回boolean

Methods方法

hasServer

hasServer(address: string): boolean

- ~~Defined in~~ 定义位置：src/sdam/topology_description.ts:322
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:176
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:142
Returns a new TopologyDescription based on the SrvPollingEvent

internal

~~Parameters~~参数
- ev: SrvPollingEvent
~~Returns~~返回TopologyDescription

Generated using TypeDoc