RUBY-1096 Deprecate PrimaryElected event in favor of MemberDiscovered event

estolfo · estolfo · commit d6bf77ffe752 · 2016-11-29T13:48:09.000+01:00
diff --git a/lib/mongo/event.rb b/lib/mongo/event.rb
@@ -31,6 +31,8 @@ module Event
     # When a server is elected primary.
     #
     # @since 2.0.0
+    #
+    # @deprecated. Will be removed in 3.0
     PRIMARY_ELECTED = 'primary_elected'.freeze
 
     # When a server is discovered to be a member of a topology.
diff --git a/lib/mongo/event/primary_elected.rb b/lib/mongo/event/primary_elected.rb
@@ -18,6 +18,8 @@ module Event
     # This handles primary elected events for server descriptions.
     #
     # @since 2.0.0
+    #
+    # @deprecated. Will be removed in 3.0
     class PrimaryElected
 
       # @return [ Mongo::Cluster ] cluster The cluster.
diff --git a/lib/mongo/server/description/inspector.rb b/lib/mongo/server/description/inspector.rb
@@ -13,6 +13,7 @@
 # limitations under the License.
 
 require 'mongo/server/description/inspector/member_discovered'
+# @deprecated. Will be removed in 3.0
 require 'mongo/server/description/inspector/primary_elected'
 require 'mongo/server/description/inspector/description_changed'
 require 'mongo/server/description/inspector/standalone_discovered'
diff --git a/lib/mongo/server/description/inspector/primary_elected.rb b/lib/mongo/server/description/inspector/primary_elected.rb
@@ -21,6 +21,8 @@ class Inspector
         # server was elected primary.
         #
         # @since 2.0.0
+        #
+        # @deprecated. Will be removed in 3.0
         class PrimaryElected
           include Event::Publisher
 

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@ module Event`
`31`	`31`	`# When a server is elected primary.`
`32`	`32`	`#`
`33`	`33`	`# @since 2.0.0`
	`34`	`+ #`
	`35`	`+ # @deprecated. Will be removed in 3.0`
`34`	`36`	`PRIMARY_ELECTED = 'primary_elected'.freeze`
`35`	`37`
`36`	`38`	`# When a server is discovered to be a member of a topology.`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,8 @@ module Event`
`18`	`18`	`# This handles primary elected events for server descriptions.`
`19`	`19`	`#`
`20`	`20`	`# @since 2.0.0`
	`21`	`+ #`
	`22`	`+ # @deprecated. Will be removed in 3.0`
`21`	`23`	`class PrimaryElected`
`22`	`24`
`23`	`25`	`# @return [ Mongo::Cluster ] cluster The cluster.`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ class Inspector`
`21`	`21`	`# server was elected primary.`
`22`	`22`	`#`
`23`	`23`	`# @since 2.0.0`
	`24`	`+ #`
	`25`	`+ # @deprecated. Will be removed in 3.0`
`24`	`26`	`class PrimaryElected`
`25`	`27`	`include Event::Publisher`
`26`	`28`