Clase: Mongo::Protocolo::Respuesta

Hereda:
Mensaje
  • Objeto
Mostrar todo
Definido en:
lib/mongo/protocol/reply.rb

Overview

El mensaje del protocolo de conexión MongoDB que representa una respuesta

Ejemplos:

socket = TCPSocket.new('localhost', 27017)
query = Protocol::Query.new('xgen', 'users', {:name => 'Tyler'})
socket.write(query)
reply = Protocol::Reply::deserialize(socket)

Definido bajo Namespace

Clases: Convertidor ascendente

Resumen constante

Constantes heredadas de Message

Message::BATCH_SIZE, Message::colección, Message::LIMIT, Message::MAX_MESSAGE_SIZE, Message::ORDERED, Message::Q

Resumen de atributos de la instancia colapsar

Atributos heredados de Mensaje

#request_id

Resumen del método de instancia colapsar

Métodos heredados de Mensaje

#==, deserializar, deserializar_matriz, deserializar_campo, deserializar_encabezado, campo, campos, #hash, #inicializar, #tal vez_agregar_api_de_servidor, #tal vez_comprimir, #tal vez_descifrar, #tal vez_cifrar, #tal vez_inflar, #¿Sepuede responder?, #serializar, #establecer_id_de_solicitud

Métodos incluidos de Id

incluido

Detalles del constructor

Esta clase hereda un constructor de Mongo::Protocol::Message

Detalles de los atributos de instancia

#cursor_id ⇒ Fixnum

Devuelve el id del cursor para esta respuesta. Será cero si no hay resultados adicionales.

Devuelve:

  • (Fixnum) —

    El ID del cursor para esta respuesta. Será cero si no hay resultados adicionales.



103
 
# Archivo 'lib/mongo/protocol/reply.rb', línea 103

Campo :cursor_id, Int64

#documentos ⇒ arreglo<Hash>

Devuelve los documentos en esta Respuesta.

Devuelve:

  • (arreglo<Hash>) —

    Los documentos en esta respuesta.



115
 
# Archivo 'lib/mongo/protocol/reply.rb', línea 115

Campo :documentos, Documento, Derivado: @number_returned

#flags ⇒ Array<Symbol>

Devuelve los indicadores de esta respuesta.

Banderas admitidas: :cursor_not_found, :query_failure, :shard_config_stale, :await_capable.

Devuelve:

  • (arreglo<Symbol>) —

    Las banderas para esta respuesta.

    Banderas admitidas: :cursor_not_found, :query_failure, :shard_config_stale, :await_capable



98
 
# Archivo 'lib/mongo/protocol/reply.rb', línea 98

Campo :flags, BitVector.Nuevo(FLAGS)

#number_returned ⇒ Fixnum

Devuelve el número de documentos en esta respuesta.

Devuelve:

  • (Fixnum) —

    Número de documentos en esta respuesta.



111
 
# Archivo 'lib/mongo/protocol/reply.rb', línea 111

Campo :number_returned, Int32

#desde_inicio ⇒ Fixnum

Devuelve la posición inicial del cursor para esta Respuesta.

Devuelve:

  • (Fixnum) —

    La posición inicial del cursor para esta respuesta.



107
 
# Archivo 'lib/mongo/protocol/reply.rb', línea 107

Campo a partir de, Int32

Detalles del método de instancia

#cursor_not_found? ⇒ true, false

Determine si la respuesta tenía una bandera de cursor no encontrado.

Ejemplos:

¿Tuvo la respuesta una bandera de cursor no encontrado?

reply.cursor_not_found?

Devuelve:

  • (verdadero,falso) —

    Si no se encontró el cursor de la query.

Desde:

  • 2.2.3



52
53
54
 
# Archivo 'lib/mongo/protocol/reply.rb', línea 52

def ¿cursor_no_encontrado?
  flags.incluir?(cursor_not_found)
end

#carga útil ⇒ BSON::Document

Devuelve la carga útil del evento para su supervisión.

Ejemplos:

Devuelve la carga útil del evento.

message.payload

Devuelve:

  • (BSON::Document) —

    La carga útil del evento.

Desde:

  • 2.1.0



64
65
66
67
68
69
 
# Archivo 'lib/mongo/protocol/reply.rb', línea 64

def payload
  BSON::Documento.Nuevo(
    responder: convertidor ascendente.Comando,
    request_id: id de solicitud
  )
end

#gaquery_failure? ⇒ true, false

Determine si la respuesta tenía un indicador de falla de query.

Ejemplos:

¿La respuesta tuvo un error de consulta?

reply.query_failure?

Devuelve:

  • (verdadero,falso) —

    Si la query falló.

Desde:

  • 2.0.5



40
41
42
 
# Archivo 'lib/mongo/protocol/reply.rb', línea 40

def query_failure?
  flags.incluir?(Falló la consulta)
end