Class ReplyMessage<TDocument>

Namespace

MongoDB.Driver.Core.WireProtocol.Messages

Assembly

MongoDB.Driver.Core.dll

Represents a Reply message.

public class ReplyMessage<TDocument> : ResponseMessage, IEncodableMessage

Type Parameters

TDocument

The type of the document.

Inheritance

object

MongoDBMessage

ResponseMessage

ReplyMessage<TDocument>

Implements

IEncodableMessage

Inherited Members

ResponseMessage.RequestId

ResponseMessage.ResponseTo

MongoDBMessage.MayBeCompressed

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ReplyMessage(bool, long, bool, List<TDocument>, int, bool, BsonDocument, int, int, IBsonSerializer<TDocument>, int)

Initializes a new instance of the ReplyMessage<TDocument> class.

public ReplyMessage(bool awaitCapable, long cursorId, bool cursorNotFound, List<TDocument> documents, int numberReturned, bool queryFailure, BsonDocument queryFailureDocument, int requestId, int responseTo, IBsonSerializer<TDocument> serializer, int startingFrom)

Parameters

awaitCapable bool

if set to true the server is await capable.

cursorId long

The cursor identifier.

cursorNotFound bool

if set to true the cursor was not found.

documents List<TDocument>

The documents.

numberReturned int

The number of documents returned.

queryFailure bool

if set to true the query failed.

queryFailureDocument BsonDocument

The query failure document.

requestId int

The request identifier.

responseTo int

The identifier of the message this is a response to.

serializer IBsonSerializer<TDocument>

The serializer.

startingFrom int

The position of the first document in this batch in the overall result.

Properties

AwaitCapable

Gets a value indicating whether the server is await capable.

public bool AwaitCapable { get; }

Property Value

bool

CursorId

Gets the cursor identifier.

public long CursorId { get; }

Property Value

long

CursorNotFound

Gets a value indicating whether the cursor was not found.

public bool CursorNotFound { get; }

Property Value

bool

Documents

Gets the documents.

public List<TDocument> Documents { get; }

Property Value

List<TDocument>

MessageType

Gets the type of the message.

public override MongoDBMessageType MessageType { get; }

Property Value

MongoDBMessageType

NumberReturned

Gets the number of documents returned.

public int NumberReturned { get; }

Property Value

int

QueryFailure

Gets a value indicating whether the query failed.

public bool QueryFailure { get; }

Property Value

bool

QueryFailureDocument

Gets the query failure document.

public BsonDocument QueryFailureDocument { get; }

Property Value

BsonDocument

Serializer

Gets the serializer.

public IBsonSerializer<TDocument> Serializer { get; }

Property Value

IBsonSerializer<TDocument>

StartingFrom

Gets the position of the first document in this batch in the overall result.

public int StartingFrom { get; }

Property Value

int

Methods

GetEncoder(IMessageEncoderFactory)

Gets an encoder for the message from an encoder factory.

public override IMessageEncoder GetEncoder(IMessageEncoderFactory encoderFactory)

Parameters

encoderFactory IMessageEncoderFactory

The encoder factory.

Returns

IMessageEncoder

A message encoder.