class Mongo::Cluster::Topology::Unknown

Defines behavior 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

Public Instance Methods

display_name() click to toggle source

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 38
def display_name
  self.class.name.gsub(/.*::/, '')
end
has_readable_server?(cluster, server_selector = nil) click to toggle source

Determine if the topology would select a readable server for the provided candidates and read preference.

@example Is a readable server present?

topology.has_readable_server?(cluster, server_selector)

@param [ Cluster ] cluster The cluster. @param [ ServerSelector ] server_selector The server

selector.

@return [ false ] An Unknown topology will never have a readable server.

@since 2.4.0

# File lib/mongo/cluster/topology/unknown.rb, line 64
def has_readable_server?(cluster, server_selector = nil); false; end
has_writable_server?(cluster) click to toggle source

Determine if the topology would select a writable server for the provided candidates.

@example Is a writable server present?

topology.has_writable_server?(servers)

@param [ Cluster ] cluster The cluster.

@return [ false ] An Unknown topology will never have a writable server.

@since 2.4.0

# File lib/mongo/cluster/topology/unknown.rb, line 77
def has_writable_server?(cluster); false; end
replica_set?() click to toggle source

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 87
def replica_set?; false; end
servers(servers) click to toggle source

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 100
def servers(servers)
  []
end
sharded?() click to toggle source

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 112
def sharded?; false; end
single?() click to toggle source

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 122
def single?; false; end
summary() click to toggle source

@note This method is experimental and subject to change.

@api experimental @since 2.7.0

# File lib/mongo/cluster/topology/unknown.rb, line 46
def summary
  details = server_descriptions.keys.join(',')
  "#{display_name}[#{details}]"
end
unknown?() click to toggle source

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 132
def unknown?; true; end