ServerDescription

The client's view of a single server, based on the most recent ismaster outcome.

Internal type, not meant to be directly instantiated

Hierarchy

ServerDescription

Index

Constructors

constructor

Accessors

Methods

equals

Constructors

constructor

new ServerDescription(address: string | HostAddress, ismaster?: Document, options?: ServerDescriptionOptions): ServerDescription

- Defined in src/sdam/server_description.ts:86
Create a ServerDescription

internal

Parameters
- address: string | HostAddress
  
  The address of the server
- Optional ismaster: Document
  
  An optional ismaster response for this server
- Optional options: ServerDescriptionOptions
Returns ServerDescription

Properties

Optional $clusterTime

$clusterTime: ClusterTime

Private _hostAddress

_hostAddress: HostAddress

address

address: string

arbiters

arbiters: string[]

Optional electionId

electionId: ObjectId

Optional error

error: MongoError

hosts

hosts: string[]

lastUpdateTime

lastUpdateTime: number

lastWriteDate

lastWriteDate: number

Optional logicalSessionTimeoutMinutes

logicalSessionTimeoutMinutes: number

maxWireVersion

maxWireVersion: number

Optional me

me: string

minWireVersion

minWireVersion: number

passives

passives: string[]

Optional primary

primary: string

roundTripTime

roundTripTime: number

Optional setName

setName: string

Optional setVersion

setVersion: number

Optional topologyVersion

topologyVersion: TopologyVersion

type

type: ServerType

Accessors

allHosts

get allHosts(): string[]

- Defined in src/sdam/server_description.ts:153
Returns string[]

host

get host(): string

- Defined in src/sdam/server_description.ts:172
Returns string

hostAddress

get hostAddress(): HostAddress

- Defined in src/sdam/server_description.ts:148
Returns HostAddress

isDataBearing

get isDataBearing(): boolean

- Defined in src/sdam/server_description.ts:163
Is this server data bearing

Returns boolean

isReadable

get isReadable(): boolean

- Defined in src/sdam/server_description.ts:158
Is this server available for reads

Returns boolean

isWritable

get isWritable(): boolean

- Defined in src/sdam/server_description.ts:168
Is this server available for writes

Returns boolean

port

get port(): number

- Defined in src/sdam/server_description.ts:177
Returns number

Methods

equals

equals(other: ServerDescription): boolean

- Defined in src/sdam/server_description.ts:186
Determines if another ServerDescription is equal to this one per the rules defined in the SDAM spec

Parameters
- other: ServerDescription
Returns boolean

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: string | HostAddress

Optional ismaster: Document

Optional options: ServerDescriptionOptions

Returns ServerDescription

Properties

Optional $clusterTime

Private _hostAddress

address

arbiters

Optional electionId

Optional error

hosts

lastUpdateTime

lastWriteDate

Optional logicalSessionTimeoutMinutes

maxWireVersion

Optional me

minWireVersion

passives

Optional primary

roundTripTime

Optional setName

Optional setVersion

tags

Optional topologyVersion

type

Accessors

allHosts

Returns string[]

host

Returns string

hostAddress

Returns HostAddress

isDataBearing

Returns boolean

isReadable

Returns boolean

isWritable

Returns boolean

port

Returns number

Methods

equals

Parameters

other: ServerDescription

Returns boolean