Classe: Mongo::Protocol::Reply

Herda:
mensagem
  • Objeto
mostrar tudo
Definido em:
build/ruby-driver-v2.19/lib/mongo/protocol/reply.rb

Visão geral

A mensagem do protocolo de conexão do MongoDB representando uma resposta

Exemplos:

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

Definido sob namespace

Classes: Upconverter

Resumo constante

Constantes herdadas de Mensagem

Mensagem::BATCH_SIZE, Mensagem::COLLECTION, Mensagem::LIMIT, Mensagem::MAX_MSSAGE_SIZE, Mensagem::ORDERED , Mensagem::Q

Recolhimento do Resumo do atributo de instância

Atributos herdados de Mensagem

#request_id

Recolhimento do Resumo do método de instância

Métodos herdados de Mensagem

., #serialize, #set_request_id

Métodos incluídos do ID

incluído

Detalhes do construtor

Esta classe herda um construtor do Mongo::Protocol::Message

Detalhes do atributo da instância

#cursor_id ⇒ Fixnum

Retorna O ID do cursor para esta resposta. será zero se não houver resultados adicionais.

Retorna:

  • (Fixnum) —

    O ID do cursor para esta resposta. será zero se não houver resultados adicionais.



103
 
# File 'build/ruby-driver-v2.19/lib/mongo/protocol/reply.rb', linha 103

Campo :cursor_id, Int64

#documents ➤ Array<Hash>

Retorna os documentos nesta resposta.

Retorna:

  • (Array<Hash>) —

    Os documentos nesta Resposta.



115
 
# File 'build/ruby-driver-v2.19/lib/mongo/protocol/reply.rb', linha 115

Campo :documents, Documento, :@number_returned

#flags ⇒ Array<Symbol>

Retorna Os sinalizadores para esta resposta.

Sinalizadores suportados: :cursor_not_found, :query_failure, :shard_config_stale, :await_capable.

Retorna:

  • (Array <Símbolo>) —

    As sinalizações para esta resposta.

    Sinalizadores suportados: :cursor_not_found, :query_failure, :shard_config_stale, :await_capable



98
 
# File 'build/ruby-driver-v2.19/lib/mongo/protocol/reply.rb', linha 98

Campo : flags, BitVector.Novo(Bandeiras)

#number_returned ➤ Fixnum

Retorna o número de documentos nesta resposta.

Retorna:

  • (Fixnum) —

    Número de documentos nesta resposta.



111
 
# File 'build/ruby-driver-v2.19/lib/mongo/protocol/reply.rb', linha 111

Campo :number_returned, Int32

#initial_from ➤ Fixnum

Retorna a posição inicial do cursor para esta resposta.

Retorna:

  • (Fixnum) —

    A posição inicial do cursor para esta resposta.



107
 
# File 'build/ruby-driver-v2.19/lib/mongo/protocol/reply.rb', linha 107

Campo :starting_from, Int32

Detalhes do método de instância

#cursor_not_Found? ➤ true, false

Determine se a resposta teve um sinalizador de cursor não encontrado.

Exemplos:

A resposta teve um sinalizador de cursor não encontrado.

reply.cursor_not_found?

Retorna:

  • (verdadeiro, falso) —

    Se o cursor de query não foi encontrado.

Desde:

  • 2.2.3



52
53
54
 
# File 'build/ruby-driver-v2.19/lib/mongo/protocol/reply.rb', linha 52

def cursor_not_Found?
  flags.incluir?(:cursor_not_Found)
end

#payload ➤ BSON::Document

Retorne a carga útil do evento para monitoramento.

Exemplos:

Retorne a carga útil do evento.

message.payload

Retorna:

  • (BSON::Document) —

    A carga útil do evento.

Desde:

  • 2.1.0



64
65
66
67
68
69
 
# File 'build/ruby-driver-v2.19/lib/mongo/protocol/reply.rb', linha 64

def Carga útil
  BSON::Documento.Novo(
    resposta: upconverter.comando,
    request_id: request_id
  )
end

#query_failure? ➤ true, false

Determine se a resposta teve um sinalizador de falha de query.

Exemplos:

A resposta teve uma falha de query.

reply.query_failure?

Retorna:

  • (verdadeiro, falso) —

    Se a query falhar.

Desde:

  • 2.0.5



40
41
42
 
# File 'build/ruby-driver-v2.19/lib/mongo/protocol/reply.rb', linha 40

def query_failure?
  flags.incluir?(:query_failure)
end