模块：Mongo::ClusterTime::Consumer Private

包含在：
Mongo::Cluster 、会话
定义于：
build/Ruby-driver-v 2.19 /lib/mongo/cluster_time.rb

Overview

该模块是私有 API 的一部分。 您应尽可能避免使用此模块，因为它将来可能会被删除或更改。

注意：

虽然此模块中定义的属性和方法是包括此模块在内的类的公共 API 的一部分，但这些方法是在此模块上定义的，而不是直接在包含的类上定义的，这一事实不是公共 API 的一部分。

该模块提供常见的集群时间跟踪行为。

实例属性摘要折叠

实例方法摘要折叠

实例属性详细信息

# cluster_time ⇒ nil | ClusterTime （只读）

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

包括此模块在内的对象跟踪的集群时间。

在版本2.9.0中进行了更改： 此属性成为 ClusterTime 的实例，而 ClusterTime 是 BSON::Document 的子类。 以前它是 BSON::Document 的实例。

返回：

由于：

  • 2.5.0



123
124
125
 
# File ' 构建/ruby-driver-v2.19/lib/ mongo /cluster_time.rb', 第123行

def cluster_time
  @cluster_time
end

实例方法详细信息

# advance_cluster_time (new_cluster_time) ⇒ ClusterTime

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

提前包含此模块的对象的跟踪集群时间文档。

参数：

  • new_cluster_time ( BSON::Document ) —

    新的集群时间文档。

返回：

由于：

  • 2.5.0



133
134
135
136
137
138
139
 
# File ' 构建/ruby-driver-v2.19/lib/ mongo /cluster_time.rb', 第133行

def advance_cluster_time(new_cluster_time)
  if @cluster_time
    @cluster_time = @cluster_time.advance(new_cluster_time)
  else
    @cluster_time = ClusterTime[new_cluster_time]
  end
end