Click or drag to resize

ServerDescription Class

Represents information about a server.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.Core.ServersServerDescription

Namespace:  MongoDB.Driver.Core.Servers
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public sealed class ServerDescription : IEquatable<ServerDescription>

The ServerDescription type exposes the following members.

Constructors
  NameDescription
Public methodServerDescription
Initializes a new instance of the ServerDescription class.
Top
Properties
  NameDescription
Public propertyAverageRoundTripTime
Gets the average round trip time.
Public propertyCanonicalEndPoint
Gets the canonical end point. This is the endpoint that the cluster knows this server by. Currently, it only applies to a replica set config and will match what is in the replica set configuration.
Public propertyElectionId
Gets the election identifier.
Public propertyEndPoint
Gets the end point.
Public propertyHeartbeatException
Gets the most recent heartbeat exception.
Public propertyHeartbeatInterval
Gets the heartbeat interval.
Public propertyHelloOk
Whether the server supports the hello command.
Public propertyIsCompatibleWithDriver
Gets a value indicating whether this server is compatible with the driver.
Public propertyIsDataBearing
Gets a value indicating whether this instance is a data bearing server.
Public propertyLastHeartbeatTimestamp
Gets the last heartbeat timestamp.
Public propertyLastUpdateTimestamp
Gets the last update timestamp (when the ServerDescription itself was last updated).
Public propertyLastWriteTimestamp
Gets the last write timestamp (from the lastWrite field of the hello or legacy hello result).
Public propertyLogicalSessionTimeout
Gets the logical session timeout.
Public propertyMaxBatchCount
Gets the maximum number of documents in a batch.
Public propertyMaxDocumentSize
Gets the maximum size of a document.
Public propertyMaxMessageSize
Gets the maximum size of a message.
Public propertyMaxWireDocumentSize
Gets the maximum size of a wire document.
Public propertyMaxWireVersion
Gets the maximum wire version.
Public propertyReasonChanged
The reason the server description was last changed.
Public propertyReplicaSetConfig
Gets the replica set configuration.
Public propertyServerId
Gets the server identifier.
Public propertyState
Gets the server state.
Public propertyTags
Gets the replica set tags.
Public propertyTopologyVersion
Gets the topology version.
Public propertyType
Gets the server type.
Public propertyVersion Obsolete.
Gets the approximate server version (only the major and minor version numbers are known).
Public propertyWireVersionRange
Gets the wire version range.
Top
Methods
  NameDescription
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodEquals(ServerDescription)
Indicates whether the current object is equal to another object of the same type.
Public methodGetHashCode
Serves as the default hash function.
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSdamEquals
Determines whether the specified ServerDescription can be considered as equal to decide should we publish sdam events or not.
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Public methodWith
Returns a new instance of ServerDescription with some values changed.
Public methodWithHeartbeatException
Returns a new ServerDescription with a new HeartbeatException.
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also