Cluster — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Cluster

Inherits:

Object

Extended by:

Forwardable

Includes:

Mongo::ClusterTime::Consumer, Event::Subscriber, Loggable, Monitoring::Publishable

Defined in:

lib/mongo/cluster.rb,
lib/mongo/cluster/topology.rb,
lib/mongo/cluster/topology.rb,
lib/mongo/cluster/sdam_flow.rb,
lib/mongo/cluster/topology/base.rb,
lib/mongo/cluster/topology/single.rb,
lib/mongo/cluster/topology/sharded.rb,
lib/mongo/cluster/topology/unknown.rb,
lib/mongo/cluster/periodic_executor.rb,
lib/mongo/cluster/reapers/cursor_reaper.rb,
lib/mongo/cluster/reapers/socket_reaper.rb,
lib/mongo/cluster/topology/load_balanced.rb,
lib/mongo/cluster/topology/no_replica_set_options.rb,
lib/mongo/cluster/topology/replica_set_no_primary.rb,
lib/mongo/cluster/topology/replica_set_with_primary.rb

Overview

Copyright © 2018-2020 MongoDB Inc.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Defined Under Namespace

Modules: Topology Classes: CursorReaper, PeriodicExecutor, SdamFlow, SocketReaper

Constant Summarycollapse

MAX_READ_RETRIES =

The default number of legacy read retries.

1

MAX_WRITE_RETRIES =

The default number of legacy write retries.

1

READ_RETRY_INTERVAL =

The default read retry interval, in seconds, when using legacy read retries.

5

IDLE_WRITE_PERIOD_SECONDS =

How often an idle primary writes a no-op to the oplog.

10

CLUSTER_TIME =

The cluster time key in responses from mongos servers.

'clusterTime'.freeze

Constants included from Loggable

Loggable::PREFIX

Instance Attribute Summary collapse

Attributes included from Mongo::ClusterTime::Consumer

#cluster_time

Attributes included from Event::Subscriber

#event_listeners

Class Method Summarycollapse

Instance Method Summarycollapse

Methods included from Mongo::ClusterTime::Consumer

#advance_cluster_time

Methods included from Loggable

#log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger

Methods included from Event::Subscriber

#subscribe_to

Methods included from Monitoring::Publishable

#publish_cmap_event, #publish_event, #publish_sdam_event

Constructor Details

#initialize(seeds, monitoring, options = Options::Redacted.new) ⇒ Cluster

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Cluster should never be directly instantiated outside of a Client.

Note:

When connecting to a mongodb+srv:// URI, the client expands such a URI into a list of servers and passes that list to the Cluster constructor. When connecting to a standalone mongod, the Cluster constructor receives the corresponding address as an array of one string.

Instantiate the new cluster.

| 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | # File 'lib/mongo/cluster.rb', line 120 def initialize(seeds, monitoring, options = Options::Redacted.new) if seeds.nil? raise ArgumentError, 'Seeds cannot be nil' end options = options.dup if options[:monitoring_io] == false && !options.key?(:cleanup) options[:cleanup] = false end @options = options.freeze @update_lock = Mutex.new @servers = [] @monitoring = monitoring @event_listeners = Event::Listeners.new @app_metadata = Server::AppMetadata.new(@options.merge(purpose: :application)) @monitor_app_metadata = Server::Monitor::AppMetadata.new(@options.merge(purpose: :monitor)) @push_monitor_app_metadata = Server::Monitor::AppMetadata.new(@options.merge(purpose: :push_monitor)) @cluster_time_lock = Mutex.new @cluster_time = nil @srv_monitor_lock = Mutex.new @srv_monitor = nil @server_selection_semaphore = Semaphore.new @topology = Topology.initial(self, monitoring, options) @state_change_lock = Mutex.new @sdam_flow_lock = Mutex.new @session_pool = Session::SessionPool.new(self) if seeds.empty? && load_balanced? raise ArgumentError, 'Load-balanced clusters with no seeds are prohibited' end opening_topology = Topology::Unknown.new(options, monitoring, self) publish_sdam_event( Monitoring::TOPOLOGY_OPENING, Monitoring::Event::TopologyOpening.new(opening_topology) ) @seeds = seeds = seeds.uniq servers = seeds.map do |seed| add(seed, monitor: false) end if seeds.size >= 1 recreate_topology(topology, opening_topology) end possibly_warn_about_compatibility! if load_balanced? fabricate_lb_sdam_events_and_set_server_type end if options[:monitoring_io] == false @connecting = @connected = false return end @connecting = false @connected = true if options[:cleanup] != false @cursor_reaper = CursorReaper.new(self) @socket_reaper = SocketReaper.new(self) @periodic_executor = PeriodicExecutor.new([ @cursor_reaper, @socket_reaper, ], options) @periodic_executor.run! end unless load_balanced? start_monotime = Utils.monotonic_time servers.each do | server| server.start_monitoring end if options[:scan] != false server_selection_timeout = options[:server_selection_timeout] | | ServerSelector::SERVER_SELECTION_TIMEOUT if server_selection_timeout < 3 server_selection_timeout = 3 end deadline = start_monotime + server_selection_timeout loop do servers = @sdam_flow_lock.synchronize do servers_list.dup end if servers.all? { | server| server.last_scan_monotime && server.last_scan_monotime >= start_monotime } break end if (time_remaining = deadline - Utils.monotonic_time) <= 0 break end log_debug("Waiting for up to #{'%.2f' % time_remaining} seconds for servers to be scanned: #{summary}") begin server_selection_semaphore.wait([time_remaining, 0.5].min) rescue ::Timeout::Error end end end start_stop_srv_monitor end end | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

Instance Attribute Details

#app_metadata ⇒ Mongo::Server::AppMetadata

Returns The application metadata, used for connection handshakes.

319 320 321 # File 'lib/mongo/cluster.rb', line 319 def app_metadata @app_metadata end

#monitor_app_metadata ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

322 323 324 # File 'lib/mongo/cluster.rb', line 322 def monitor_app_metadata @monitor_app_metadata end

#monitoring ⇒ Monitoring

Returns monitoring The monitoring.

310 311 312 # File 'lib/mongo/cluster.rb', line 310 def monitoring @monitoring end

#options ⇒ Hash

Returns The options hash.

307 308 309 # File 'lib/mongo/cluster.rb', line 307 def options @options end

#push_monitor_app_metadata ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

325 326 327 # File 'lib/mongo/cluster.rb', line 325 def push_monitor_app_metadata @push_monitor_app_metadata end

#seeds ⇒ Array

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns The addresses of seed servers. Contains addresses that were given to Cluster when it was instantiated, not current addresses that the cluster is using as a result of SDAM.

333 334 335 # File 'lib/mongo/cluster.rb', line 333 def seeds @seeds end

#server_selection_semaphore ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

490 491 492 # File 'lib/mongo/cluster.rb', line 490 def server_selection_semaphore @server_selection_semaphore end

#session_pool ⇒ Object

338 339 340 # File 'lib/mongo/cluster.rb', line 338 def session_pool @session_pool end

#srv_monitor ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

360 361 362 # File 'lib/mongo/cluster.rb', line 360 def srv_monitor @srv_monitor end

#topology ⇒ Integer?

The logical session timeout value in minutes.

313 314 315 # File 'lib/mongo/cluster.rb', line 313 def topology @topology end

Class Method Details

.create(client, monitoring: nil) ⇒ Cluster

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create a cluster for the provided client, for use when we don’t want the client’s original cluster instance to be the same.

| 297 298 299 300 301 302 303 304 | # File 'lib/mongo/cluster.rb', line 297 def self.create(client, monitoring: nil) cluster = Cluster.new( client.cluster.addresses.map(&:to_s), monitoring || Monitoring.new, client.cluster_options, ) client.instance_variable_set(:@cluster, cluster) end | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

Instance Method Details

#==(other) ⇒ true, false

Determine if this cluster of servers is equal to another object. Checks the servers currently in the cluster, not what was configured.

740 741 742 743 # File 'lib/mongo/cluster.rb', line 740 def ==(other) return false unless other.is_a?(Cluster) addresses == other.addresses && options == other.options end

#add(host, add_options = nil) ⇒ Server

Add a server to the cluster with the provided address. Useful in auto-discovery of new servers when an existing server executes a hello and potentially non-configured servers were included.

| 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 | # File 'lib/mongo/cluster.rb', line 845 def add(host, add_options=nil) address = Address.new(host, options) if !addresses.include?(address) opts = options.merge(monitor: false) opts.merge!(populator_io: false) unless options.fetch(:monitoring_io, true) server = Server.new(address, self, @monitoring, event_listeners, opts) @update_lock.synchronize do return if @servers.map(&:address).include?(address) @servers.push(server) end if add_options.nil? || add_options[:monitor] != false server.start_monitoring end server end end | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

#addresses ⇒ Array<Mongo::Address>

The addresses in the cluster.

453 454 455 # File 'lib/mongo/cluster.rb', line 453 def addresses servers_list.map(&:address) end

#close ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Applications should call Client#close to disconnect from

Closes the cluster.

the cluster rather than calling this method. This method is for internal driver use only.

Disconnects all servers in the cluster, publishing appropriate SDAM events in the process. Stops SRV monitoring if it is active. Marks the cluster disconnected.

A closed cluster is no longer usable. If the client is reconnected, it will create a new cluster instance.

| 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 | # File 'lib/mongo/cluster.rb', line 508 def close @state_change_lock.synchronize do unless connecting? || connected? return nil end if options[:cleanup] != false session_pool.end_sessions @periodic_executor.stop! end @srv_monitor_lock.synchronize do if @srv_monitor @srv_monitor.stop! end end @servers.each do | server| if server.connected? server.close publish_sdam_event( Monitoring::SERVER_CLOSED, Monitoring::Event::ServerClosed.new(server.address, topology) ) end end publish_sdam_event( Monitoring::TOPOLOGY_CLOSED, Monitoring::Event::TopologyClosed.new(topology) ) @update_lock.synchronize do @connecting = @connected = false end end nil end | | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#connected? ⇒ true|false

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Whether the cluster object is connected to its cluster.

426 427 428 429 430 # File 'lib/mongo/cluster.rb', line 426 def connected? @update_lock.synchronize do !!@connected end end

#connecting? ⇒ true|false

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Whether the cluster object is in the process of connecting to its cluster.

414 415 416 417 418 # File 'lib/mongo/cluster.rb', line 414 def connecting? @update_lock.synchronize do !!@connecting end end

#disconnect_server_if_connected(server) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

953 954 955 956 957 958 959 960 961 962 # File 'lib/mongo/cluster.rb', line 953 def disconnect_server_if_connected(server) if server.connected? server.clear_description server.disconnect! publish_sdam_event( Monitoring::SERVER_CLOSED, Monitoring::Event::ServerClosed.new(server.address, topology) ) end end

#has_readable_server?(server_selector = nil) ⇒ true, false

Determine if the cluster would select a readable server for the provided read preference.

757 758 759 # File 'lib/mongo/cluster.rb', line 757 def has_readable_server?(server_selector = nil) topology.has_readable_server?(self, server_selector) end

#has_writable_server? ⇒ true, false

Determine if the cluster would select a writable server.

769 770 771 # File 'lib/mongo/cluster.rb', line 769 def has_writable_server? topology.has_writable_server?(self) end

#heartbeat_interval ⇒ Float

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the refresh interval for the server. This will be defined via an option or will default to 10.

#inspect ⇒ String

Get the nicer formatted string for use in inspection.

475 476 477 # File 'lib/mongo/cluster.rb', line 475 def inspect "#<Mongo::Cluster:0x#{object_id} servers=#{servers} topology=#{topology.summary}>" end

#load_balanced? ⇒ true | false

Returns whether the cluster is configured to be in the load-balanced topology.

347 348 349 # File 'lib/mongo/cluster.rb', line 347 def load_balanced? topology.is_a?(Topology::LoadBalanced) end

#max_read_retries ⇒ Integer

Note:

max_read_retries should be retrieved from the Client instance, not from a Cluster instance, because clusters may be shared between clients with different values for max read retries.

Get the maximum number of times the client can retry a read operation when using legacy read retries.

| 376 377 378 | # File 'lib/mongo/cluster.rb', line 376 def max_read_retries options[:max_read_retries] || MAX_READ_RETRIES end | | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#next_primary(ping = nil, session = nil, timeout: nil) ⇒ Mongo::Server

Get the next primary server we can send an operation to.

788 789 790 791 792 793 794 795 # File 'lib/mongo/cluster.rb', line 788 def next_primary(ping = nil, session = nil, timeout: nil) ServerSelector.primary.select_server( self, nil, session, timeout: timeout ) end

#pool(server) ⇒ Server::ConnectionPool

Get the connection pool for the server.

808 809 810 # File 'lib/mongo/cluster.rb', line 808 def pool(server) server.pool end

#read_retry_interval ⇒ Float

Note:

read_retry_interval should be retrieved from the Client instance, not from a Cluster instance, because clusters may be shared between clients with different values for the read retry interval.

Get the interval, in seconds, in which read retries when using legacy read retries.

| 394 395 396 | # File 'lib/mongo/cluster.rb', line 394 def read_retry_interval options[:read_retry_interval] || READ_RETRY_INTERVAL end | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#reconnect! ⇒ true

Deprecated.

Use Client#reconnect to reconnect to the cluster instead of calling this method. This method does not send SDAM events.

Reconnect all servers.

| 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 | # File 'lib/mongo/cluster.rb', line 552 def reconnect! @state_change_lock.synchronize do @update_lock.synchronize do @connecting = true end scan! servers.each do |server| server.reconnect! end @periodic_executor.restart! @srv_monitor_lock.synchronize do if @srv_monitor @srv_monitor.run! end end @update_lock.synchronize do @connecting = false @connected = true end end end | | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#remove(host, disconnect: true) ⇒ Array<Server> | true | false

Note:

The return value of this method is not part of the driver’s public API.

Remove the server from the cluster for the provided address, if it exists.

| 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 | # File 'lib/mongo/cluster.rb', line 894 def remove(host, disconnect: true) address = Address.new(host) removed_servers = [] @update_lock.synchronize do @servers.delete_if do |server| (server.address == address).tap do | delete| if delete removed_servers << server end end end end if disconnect != false removed_servers.each do | server| disconnect_server_if_connected(server) end end if disconnect != false removed_servers.any? else removed_servers end end | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#run_sdam_flow(previous_desc, updated_desc, options = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Runs SDAM flow on the cluster.

This method can be invoked to process a new server description returned by the server on a monitoring or non-monitoring connection, and also by the driver when it marks a server unknown as a result of a (network) error.

| 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 | # File 'lib/mongo/cluster.rb', line 638 def run_sdam_flow(previous_desc, updated_desc, options = {}) if load_balanced? if updated_desc.config.empty? unless options[:keep_connection_pool] servers_list.each do |server| err = options[:scan_error] interrupt = err && (err.is_a?(Error::SocketError) | | err.is_a?(Error::SocketTimeoutError)) server.clear_connection_pool(service_id: options[:service_id], interrupt_in_use_connections: interrupt) end end end return end @sdam_flow_lock.synchronize do flow = SdamFlow.new(self, previous_desc, updated_desc, awaited: options[:awaited]) flow.server_description_changed updated_desc = flow.updated_desc unless options[:keep_connection_pool] if flow.became_unknown? servers_list.each do | server| if server.address == updated_desc.address err = options[:scan_error] interrupt = err && (err.is_a?(Error::SocketError) | | err.is_a?(Error::SocketTimeoutError)) server.clear_connection_pool(interrupt_in_use_connections: interrupt) end end end end start_stop_srv_monitor end unless updated_desc.unknown? server_selection_semaphore.broadcast end end | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#scan!(sync = true) ⇒ true

Note:

In both synchronous and asynchronous scans, each monitor thread maintains a minimum interval between scans, meaning calling this method may not initiate a scan on a particular server the very next instant.

Force a scan of all known servers in the cluster.

If the sync parameter is true which is the default, the scan is performed synchronously in the thread which called this method. Each server in the cluster is checked sequentially. If there are many servers in the cluster or they are slow to respond, this can be a long running operation.

If the sync parameter is false, this method instructs all server monitor threads to perform an immediate scan and returns without waiting for scan results.

| 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 | # File 'lib/mongo/cluster.rb', line 597 def scan!(sync=true) if sync servers_list.each do |server| if server.monitor server.monitor.scan! else log_warn("Synchronous scan requested on cluster #{summary} but server #{server} has no monitor") end end else servers_list.each do | server| server.scan_semaphore.signal end end true end | | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |

#servers ⇒ Array<Server>

Get a list of server candidates from the cluster that can have operations executed on them.

441 442 443 # File 'lib/mongo/cluster.rb', line 441 def servers topology.servers(servers_list) end

#servers_list ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

946 947 948 949 950 # File 'lib/mongo/cluster.rb', line 946 def servers_list @update_lock.synchronize do @servers.dup end end

#set_server_list(server_address_strs) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Sets the list of servers to the addresses in the provided list of address strings.

This method is called by the SRV monitor after receiving new DNS records for the monitored hostname.

Removes servers in the cluster whose addresses are not in the passed list of server addresses, and adds servers for any addresses in the argument which are not already in the cluster.

| 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 | # File 'lib/mongo/cluster.rb', line 709 def set_server_list(server_address_strs) @sdam_flow_lock.synchronize do server_address_strs.each do |address_str| unless servers_list.any? { | server| server.address.seed == address_str } add(address_str) end end servers_list.each do | server| unless server_address_strs.any? { | address_str| server.address.seed == address_str } remove(server.address.seed) end end end end | | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |

#summary ⇒ Object

Note:

This method is experimental and subject to change.

483 484 485 486 487 # File 'lib/mongo/cluster.rb', line 483 def summary "#<Cluster " + "topology=#{topology.summary} "+ "servers=[#{servers_list.map(&:summary).join(',')}]>" end

#update_cluster_time(result) ⇒ Object

Update the max cluster time seen in a response.

822 823 824 825 826 827 828 # File 'lib/mongo/cluster.rb', line 822 def update_cluster_time(result) if cluster_time_doc = result.cluster_time @cluster_time_lock.synchronize do advance_cluster_time(cluster_time_doc) end end end

#update_topology(new_topology) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 # File 'lib/mongo/cluster.rb', line 919 def update_topology(new_topology) old_topology = nil @update_lock.synchronize do old_topology = topology @topology = new_topology end if topology.data_bearing_servers? sessions_supported = !!topology.logical_session_timeout @update_lock.synchronize do @sessions_supported = sessions_supported end end publish_sdam_event( Monitoring::TOPOLOGY_CHANGED, Monitoring::Event::TopologyChanged.new(old_topology, topology) ) end

#validate_session_support!(timeout: nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Raises Error::SessionsNotAvailable if the deployment that the driver is connected to does not support sessions.

Session support may change over time, for example due to servers in the deployment being upgraded or downgraded. If the client isn’t connected to any servers and doesn’t find any servers for the duration of server selection timeout, this method will raise NoServerAvailable. This method is called from the operation execution flow, and if it raises NoServerAvailable the entire operation will fail with that exception, since the operation execution has waited for the server selection timeout for any server to become available (which would be a superset of the servers suitable for the operation being attempted) and none materialized.

988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 # File 'lib/mongo/cluster.rb', line 988 def validate_session_support!(timeout: nil) if topology.is_a?(Topology::LoadBalanced) return end @state_change_lock.synchronize do @sdam_flow_lock.synchronize do if topology.data_bearing_servers? unless topology.logical_session_timeout raise_sessions_not_supported end end end end ServerSelector.get(mode: :primary_preferred).select_server(self, timeout: timeout) @state_change_lock.synchronize do @sdam_flow_lock.synchronize do unless topology.logical_session_timeout raise_sessions_not_supported end end end end