ServerDescription Class |
Represents information about a server.
Inheritance HierarchyNamespace: MongoDB.Driver.Core.Servers
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076
SyntaxThe ServerDescription type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ServerDescription |
Initializes a new instance of the ServerDescription class.
|
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.
|
| 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.
|
| 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 isMaster 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.
|
| ReplicaSetConfig |
Gets the replica set configuration.
|
| ServerId |
Gets the server identifier.
|
| State |
Gets the server state.
|
| Tags |
Gets the replica set tags.
|
| Type |
Gets the server type.
|
| Version |
Gets the server version.
|
| WireVersionRange |
Gets the wire version range.
|
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.) |
| ToString | Returns a string that represents the current object. (Overrides ObjectToString.) |
| With |
Returns a new instance of ServerDescription with some values changed.
|
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.) |
See Also