class Mongo::Cluster::Topology::Unknown
Defines behaviour for when a cluster is in an unknown state.
@since 2.0.0
Constants
- NAME
The display name for the topology.
@since 2.0.0
Attributes
@return [ Hash ] options The options.
Public Class Methods
Initialize the topology with the options.
@example Initialize the topology.
Unknown.new(options)
@param [ Hash ] options The options.
@since 2.0.0
# File lib/mongo/cluster/topology/unknown.rb, line 73 def initialize(options, seeds = []) @options = options @seeds = seeds end
Public Instance Methods
Whether a server description's hosts may be added to the cluster.
@example Check if a description's hosts may be added to the cluster.
topology.add_hosts?(description, servers)
@param [ Mongo::Server::Description ] description The description. @param [ Array<Mongo::Server> ] servers The cluster servers.
@return [ true, false ] Whether a description's hosts may be added.
@since 2.0.6
# File lib/mongo/cluster/topology/unknown.rb, line 154 def add_hosts?(description, servers) !(description.unknown? || description.ghost?) end
Get the display name.
@example Get the display name.
Unknown.display_name
@return [ String ] The display name.
@since 2.0.0
# File lib/mongo/cluster/topology/unknown.rb, line 41 def display_name NAME end
Elect a primary server within this topology.
@example Elect a primary server.
topology.elect_primary(description, servers)
@param [ Server::Description ] description The description of the
elected primary.
@param [ Array<Server> ] servers The list of known servers to the
cluster.
@return [ Sharded, ReplicaSet ] The new topology.
# File lib/mongo/cluster/topology/unknown.rb, line 56 def elect_primary(description, servers) if description.mongos? log_debug("Mongos #{description.address.to_s} discovered.") Sharded.new(options) else initialize_replica_set(description, servers) end end
Whether a description can be used to remove hosts from the cluster.
@example Check if a description can be used to remove hosts from the cluster.
topology.remove_hosts?(description)
@param [ Mongo::Server::Description ] description The description.
@return [ true, false ] Whether hosts may be removed from the cluster.
@since 2.0.6
# File lib/mongo/cluster/topology/unknown.rb, line 168 def remove_hosts?(description) description.standalone? end
Whether a specific server in the cluster can be removed, given a description.
@example Check if a specific server can be removed from the cluster.
topology.remove_server?(description, server)
@param [ Mongo::Server::Description ] description The description. @param [ Mongo::Serve ] server The server in question.
@return [ true, false ] Whether the server can be removed from the cluster.
@since 2.0.6
# File lib/mongo/cluster/topology/unknown.rb, line 183 def remove_server?(description, server) description.standalone? && description.is_server?(server) end
An unknown topology is not a replica set.
@example Is the topology a replica set?
Unknown.replica_set?
@return [ false ] Always false.
@since 2.0.0
# File lib/mongo/cluster/topology/unknown.rb, line 86 def replica_set?; false; end
Unknown topologies have no replica set name.
@example Get the replica set name.
unknown.replica_set_name
@return [ nil ] Always nil.
@since 2.0.0
# File lib/mongo/cluster/topology/unknown.rb, line 96 def replica_set_name; nil; end
Select appropriate servers for this topology.
@example Select the servers.
Unknown.servers(servers)
@param [ Array<Server> ] servers The known servers.
@raise [ Unknown ] Cannot select servers when the topology is
unknown.
@since 2.0.0
# File lib/mongo/cluster/topology/unknown.rb, line 109 def servers(servers) [] end
An unknown topology is not sharded.
@example Is the topology sharded?
Unknown.sharded?
@return [ false ] Always false.
@since 2.0.0
# File lib/mongo/cluster/topology/unknown.rb, line 121 def sharded?; false; end
An unknown topology is not single.
@example Is the topology single?
Unknown.single?
@return [ true ] Always false.
@since 2.0.0
# File lib/mongo/cluster/topology/unknown.rb, line 131 def single?; false; end
Notify the topology that a standalone was discovered.
@example Notify the topology that a standalone was discovered.
topology.standalone_discovered
@return [ Topology::Unknown, Topology::Single ] Either self or a
new Single topology.
@since 2.0.6
# File lib/mongo/cluster/topology/unknown.rb, line 196 def standalone_discovered if @seeds.size == 1 Single.new(options, @seeds) else self end end
An unknown topology is unknown.
@example Is the topology unknown?
Unknown.unknown?
@return [ true ] Always true.
@since 2.0.0
# File lib/mongo/cluster/topology/unknown.rb, line 141 def unknown?; true; end
Private Instance Methods
# File lib/mongo/cluster/topology/unknown.rb, line 206 def initialize_replica_set(description, servers) log_debug( "Server #{description.address.to_s} discovered as primary in replica set: " + "'#{description.replica_set_name}'. Changing topology to replica set." ) servers.each do |server| if server.standalone? && server.address != description.address server.description.unknown! end end ReplicaSet.new(options.merge(:replica_set => description.replica_set_name)) end