モジュール: Mongo::ClusterTime::Consumer Private

次のドキュメントに含まれます。
Mongo::ClusterSession
定義:
lib/mongo/cluster_time.rb

Overview

このモジュールはプライベート API の一部です。 このモジュールは将来削除または変更される可能性があるため、可能な限り使用しないでください。

注:

このモジュールで定義される属性とメソッドは、このモジュールを含むクラスの公開 API の一部ですが、メソッドがこのモジュールで定義され、含まれるクラスで直接定義されていないという点は、公開 API の一部ではありません。

このモジュールは、一般的なクラスター時間追跡動作を提供します。

インスタンス属性の概要を折りたたむ

インスタンス メソッドの概要を折りたたむ

インスタンス属性の詳細

# cluster_time = nil | nil | ClusterTime (読み取り専用)

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

このモジュールを含むオブジェクトによって追跡されるクラスター時間。

バージョン2.9.0での変更 : この属性は、BSON::Document のサブクラスである ClusterTime のインスタンスになりました。 以前は BSON::Document のインスタンスでした。

次の値を返します。

以来

  • 2.5.0


123
124
125
# ファイル 'lib/mongo/cluster_time.rb' 行 123

デフォルト cluster_time
  @cluster_time
end

インスタンス メソッドの詳細

#advance_cluster_time(new_cluster_time) ⇒ ClusterTime

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

このモジュールを含むオブジェクトの追跡されるクラスター時間ドキュメントを進める。

パラメーター:

  • new_cluster_time BSON::Document

    新しいクラスター時間ドキュメント。

次の値を返します。

  • ClusterTime

    結果のクラスター時間。

以来

  • 2.5.0

[ソースを表示]

133
134
135
136
137
138
139
# ファイル 'lib/mongo/cluster_time.rb' 行 133

デフォルト advanced_cluster_time(new_cluster_time)
  場合 @cluster_time
    @cluster_time = @cluster_time.事前(new_cluster_time)
  else
    @cluster_time = ClusterTime[new_cluster_time]
  end
end