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.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a

Syntax

Copy

public sealed class ServerDescription : IEquatable<ServerDescription>

Public NotInheritable Class ServerDescription
	Implements IEquatable(Of ServerDescription)

[<SealedAttribute>]
type ServerDescription =  
    class
        interface IEquatable<ServerDescription>
    end

The ServerDescription type exposes the following members.

Constructors

	Name	Description
	ServerDescription	Initializes a new instance of the ServerDescription class.

Top

Properties

	Name	Description
	AverageRoundTripTime	Gets the average round trip time.
	CanonicalEndPoint	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.
	ElectionId	Gets the election identifier.
	EndPoint	Gets the end point.
	HeartbeatException	Gets the most recent heartbeat exception.
	HeartbeatInterval	Gets the heartbeat interval.
	HelloOk	Whether the server supports the hello command.
	IsCompatibleWithDriver	Gets a value indicating whether this server is compatible with the driver.
	IsDataBearing	Gets a value indicating whether this instance is a data bearing server.
	LastHeartbeatTimestamp	Gets the last heartbeat timestamp.
	LastUpdateTimestamp	Gets the last update timestamp (when the ServerDescription itself was last updated).
	LastWriteTimestamp	Gets the last write timestamp (from the lastWrite field of the hello or legacy hello result).
	LogicalSessionTimeout	Gets the logical session timeout.
	MaxBatchCount	Gets the maximum number of documents in a batch.
	MaxDocumentSize	Gets the maximum size of a document.
	MaxMessageSize	Gets the maximum size of a message.
	MaxWireDocumentSize	Gets the maximum size of a wire document.
	MaxWireVersion	Gets the maximum wire version.
	ReasonChanged	The reason the server description was last changed.
	ReplicaSetConfig	Gets the replica set configuration.
	ServerId	Gets the server identifier.
	State	Gets the server state.
	Tags	Gets the replica set tags.
	TopologyVersion	Gets the topology version.
	Type	Gets the server type.
	Version	Obsolete. Gets the approximate server version (only the major and minor version numbers are known).
	WireVersionRange	Gets the wire version range.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).)
	Equals(ServerDescription)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SdamEquals	Determines whether the specified ServerDescription can be considered as equal to decide should we publish sdam events or not.
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	With	Returns a new instance of ServerDescription with some values changed.
	WithHeartbeatException	Returns a new ServerDescription with a new HeartbeatException.

Top

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)

Top

Reference

MongoDB.Driver.Core.Servers Namespace