Módulo: Mongo::ClusterTime::Consumer Private

Incluído em:

Mongo::Cluster, Session

Definido em:

build/ruby-driver-v2.19/lib/mongo/cluster_time.rb

Visão geral

Este módulo faz parte de uma API privada. Você deve evitar usar este módulo, se possível, pois ele pode ser removido ou alterado no futuro.

Observação:

Embora os atributos e métodos definidos neste módulo façam parte da API pública para as classes que incluem este módulo, o fato de os métodos serem definidos neste módulo e não diretamente nas classes inclusivas não faz parte da API pública.

Este módulo fornece um comportamento comum de rastreamento de tempo de cluster.

Recolhimento do Resumo do atributo de

• #cluster_time ⇒ nil | ClusterTime Somente leitura privado

  O tempo de agrupamento monitorado pelo objeto incluindo este módulo.

Recolhimento do Resumo do método de

• #advance_cluster_time(new_cluster_time) ⇒ ClusterTime privado

  Avance o documento de tempo de cluster rastreado para o objeto, incluindo este módulo.

Detalhes do atributo da instância

#cluster_time ➤ nil | ClusterTime (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

O tempo de agrupamento monitorado pelo objeto incluindo este módulo.

Alterado na versão 2.9.0: Esse atributo se tornou uma instância de ClusterTime, que é uma subclasse de BSON::Document. Anteriormente, era uma instância de BSON::Document.

Retorna:

• (nil | ClusterTime) —

  O tempo de agrupamento.

Desde:

• 2.5.0

# File 'build/ruby-driver-v2.19/lib/mongo/cluster_time.rb', linha 123

def cluster_time
  @cluster_time
end

Detalhes do método de instância

# advanced_cluster_time ( new_cluster_time) ➤ ClusterTime

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Avance o documento de tempo de cluster rastreado para o objeto, incluindo este módulo.

Parâmetros:

• new_cluster_time (BSON::Document) —

  O novo documento de tempo do cluster.

Retorna:

• (ClusterTime) —

  O tempo de cluster resultante.

Desde:

• 2.5.0

# File 'build/ruby-driver-v2.19/lib/mongo/cluster_time.rb', linha 133

def advanced_cluster_time(new_cluster_time)
  se @cluster_time
    @cluster_time = @cluster_time.avance(new_cluster_time)
  mais
    @cluster_time = ClusterTime[new_cluster_time]
  end
end