Reply — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Protocol::Reply

Overview

The MongoDB wire protocol message representing a reply

Defined Under Namespace

Classes: Upconverter

Constant Summary

Constants inherited from Message

Message::BATCH_SIZE, Message::COLLECTION, Message::LIMIT, Message::MAX_MESSAGE_SIZE, Message::ORDERED, Message::Q

Instance Attribute Summary collapse

• #cursor_id ⇒ Fixnum
  The cursor id for this response.
• #documents ⇒ Array
  The documents in this Reply.
• #flags ⇒ Array
  The flags for this reply.
• #number_returned ⇒ Fixnum
  Number of documents in this Reply.
• #starting_from ⇒ Fixnum
  The starting position of the cursor for this Reply.

Attributes inherited from Message

#request_id

Instance Method Summarycollapse

• #cursor_not_found? ⇒ true, false
  Determine if the reply had a cursor not found flag.
• #payload ⇒ BSON::Document
  Return the event payload for monitoring.
• #query_failure? ⇒ true, false
  Determine if the reply had a query failure flag.

Methods inherited from Message

#==, deserialize, #hash, #initialize, #maybe_add_server_api, #maybe_compress, #maybe_decrypt, #maybe_encrypt, #maybe_inflate, #replyable?, #serialize, #set_request_id

Methods included from Id

included

Instance Attribute Details

#cursor_id ⇒ Fixnum

Returns The cursor id for this response. Will be zero if there are no additional results.

#documents ⇒ Array

Returns The documents in this Reply.

#flags ⇒ Array<Symbol>

Returns The flags for this reply.

Supported flags: :cursor_not_found, :query_failure, :shard_config_stale, :await_capable.

#number_returned ⇒ Fixnum

Returns Number of documents in this Reply.

#starting_from ⇒ Fixnum

Returns The starting position of the cursor for this Reply.

Instance Method Details

#cursor_not_found? ⇒ true, false

Determine if the reply had a cursor not found flag.

#payload ⇒ BSON::Document

Return the event payload for monitoring.

#query_failure? ⇒ true, false

Determine if the reply had a query failure flag.