Class ConnectionDescription

Namespace

MongoDB.Driver.Core.Connections

Assembly

MongoDB.Driver.Core.dll

Represents information describing a connection.

public sealed class ConnectionDescription : IEquatable<ConnectionDescription>

Inheritance

object

ConnectionDescription

Implements

IEquatable<ConnectionDescription>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConnectionDescription(ConnectionId, HelloResult)

Initializes a new instance of the ConnectionDescription class.

public ConnectionDescription(ConnectionId connectionId, HelloResult helloResult)

Parameters

connectionId ConnectionId

The connection identifier.

helloResult HelloResult

The hello result.

Properties

AvailableCompressors

Gets the available compressors.

public IReadOnlyList<CompressorType> AvailableCompressors { get; }

Property Value

IReadOnlyList<CompressorType>

ConnectionId

Gets the connection identifier.

public ConnectionId ConnectionId { get; }

Property Value

ConnectionId

The connection identifier.

HelloResult

Gets the hello result.

public HelloResult HelloResult { get; }

Property Value

HelloResult

The hello result.

IsMasterResult

Gets the hello result.

[Obsolete("Use HelloResult instead.")]
public IsMasterResult IsMasterResult { get; }

Property Value

IsMasterResult

The hello result.

MaxBatchCount

Gets the maximum number of documents in a batch.

public int MaxBatchCount { get; }

Property Value

int

The maximum number of documents in a batch.

MaxDocumentSize

Gets the maximum size of a document.

public int MaxDocumentSize { get; }

Property Value

int

The maximum size of a document.

MaxMessageSize

Gets the maximum size of a message.

public int MaxMessageSize { get; }

Property Value

int

The maximum size of a message.

MaxWireDocumentSize

Gets the maximum size of a wire document.

public int MaxWireDocumentSize { get; }

Property Value

int

The maximum size of a wire document.

MaxWireVersion

Gets the maximum wire version.

public int MaxWireVersion { get; }

Property Value

int

The maximum wire version.

MinWireVersion

Gets the minimum wire version.

public int MinWireVersion { get; }

Property Value

int

The minimum wire version.

ServerVersion

Gets the server version.

[Obsolete("Use MaxWireVersion instead.")]
public SemanticVersion ServerVersion { get; }

Property Value

SemanticVersion

The server version.

ServiceId

Gets the service identifier.

public ObjectId? ServiceId { get; }

Property Value

ObjectId?

The service identifier.

Methods

Equals(ConnectionDescription)

public bool Equals(ConnectionDescription other)

Parameters

other ConnectionDescription

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

WithConnectionId(ConnectionId)

Returns a new instance of ConnectionDescription with a different connection identifier.

public ConnectionDescription WithConnectionId(ConnectionId value)

Parameters

value ConnectionId

The value.

Returns

ConnectionDescription

A connection description.