class Mongo::Server
Represents a single server on the server side that can be standalone, part of a replica set, or a mongos.
@since 2.0.0
Constants
- CONNECT_TIMEOUT
The default time in seconds to timeout a connection attempt.
@since 2.4.3
Attributes
@return [ String ] The configured address for the server.
@return [ Cluster
] cluster The server cluster.
@return [ Server::Description
] description The server
description the monitor refreshes.
@return [ nil | Monitor
] monitor The server monitor. nil if the servenr
was created with monitoring_io: false option.
@return [ Monitoring
] monitoring The monitoring.
@return [ Hash ] The options hash.
@return [ RoundTripTimeAverager
] Round trip time averager object. @api private
Public Class Methods
Instantiate a new server object. Will start the background refresh and subscribe to the appropriate events.
@api private
@example Initialize the server.
Mongo::Server.new('127.0.0.1:27017', cluster, monitoring, listeners)
@note Server
must never be directly instantiated outside of a Cluster
.
@param [ Address
] address The host:port address to connect to. @param [ Cluster
] cluster The cluster the server belongs to. @param [ Monitoring
] monitoring The monitoring. @param [ Event::Listeners
] event_listeners The event listeners. @param [ Hash ] options The server options.
@option options [ Boolean ] :monitor For internal driver use only:
whether to monitor the server after instantiating it.
@option options [ true, false ] :monitoring_io For internal driver
use only. Set to false to prevent SDAM-related I/O from being done by this server. Note: setting this option to false will make the server non-functional. It is intended for use in tests which manually invoke SDAM state transitions.
@option options [ true | false ] :load_balancer Whether this server
is a load balancer.
@option options [ String ] :connect The client connection mode.
@since 2.0.0
# File lib/mongo/server.rb, line 62 def initialize(address, cluster, monitoring, event_listeners, options = {}) @address = address @cluster = cluster @monitoring = monitoring options = options.dup _monitor = options.delete(:monitor) @options = options.freeze @event_listeners = event_listeners @connection_id_gen = Class.new do include Id end @scan_semaphore = DistinguishingSemaphore.new @round_trip_time_averager = RoundTripTimeAverager.new @description = Description.new(address, {}, load_balancer: !!@options[:load_balancer], force_load_balancer: force_load_balancer?, ) @last_scan = nil @last_scan_monotime = nil unless options[:monitoring_io] == false @monitor = Monitor.new(self, event_listeners, monitoring, options.merge( app_metadata: cluster.monitor_app_metadata, push_monitor_app_metadata: cluster.push_monitor_app_metadata, heartbeat_interval: cluster.heartbeat_interval, )) unless _monitor == false start_monitoring end end @connected = true @pool_lock = Mutex.new end
Public Instance Methods
Is this server equal to another?
@example Is the server equal to the other?
server == other
@param [ Object ] other The object to compare to.
@return [ true, false ] If the servers are equal.
@since 2.0.0
# File lib/mongo/server.rb, line 236 def ==(other) return false unless other.is_a?(Server) address == other.address end
@param [ Object ] :service_id Close connections with the specified
service id only.
@api private
# File lib/mongo/server.rb, line 601 def clear_connection_pool(service_id: nil) @pool_lock.synchronize do if @pool @pool.disconnect!(service_id: service_id) end end end
The compressor negotiated by the server monitor, if any.
This attribute is nil if no server check has not yet completed, and if no compression was negatiated.
@note Compression is negotiated for each connection separately.
@return [ String | nil ] The negotiated compressor.
@deprecated
# File lib/mongo/server.rb, line 172 def compressor if monitor monitor.compressor else nil end end
Determine if a connection to the server is able to be established and messages can be sent to it.
@example Is the server connectable?
server.connectable?
@return [ true, false ] If the server is connectable.
@since 2.1.0
@deprecated No longer necessary with Server
Selection specification.
# File lib/mongo/server.rb, line 252 def connectable?; end
Whether the server is connected.
@return [ true|false ] Whether the server is connected.
@api private @since 2.7.0
# File lib/mongo/server.rb, line 295 def connected? @connected end
Disconnect the driver from this server.
Disconnects all idle connections to this server in its connection pool, if any exist. Stops the populator of the connection pool, if it is running. Does not immediately close connections which are presently checked out (i.e. in use) - such connections will be closed when they are returned to their respective connection pools. Stop the server’s background monitor.
@return [ true ] Always true.
@since 2.0.0
# File lib/mongo/server.rb, line 266 def disconnect! if monitor monitor.stop! end _pool = @pool_lock.synchronize do @pool end if _pool # For backwards compatibility we disconnect/clear the pool rather # than close it here. We also stop the populator which allows the # the pool to continue providing connections but stops it from # connecting in background on clients/servers that are in fact # intended to be closed and no longer used. begin _pool.disconnect!(stop_populator: true) rescue Error::PoolClosedError # If the pool was already closed, we don't need to do anything here. end end @connected = false true end
Returns whether this server is forced to be a load balancer.
@return [ true | false ] Whether this server is forced to be a load balancer.
@api private
# File lib/mongo/server.rb, line 121 def force_load_balancer? options[:connect] == :load_balanced end
Handle authentication failure.
@example Handle possible authentication failure.
server.handle_auth_failure! do Auth.get(user).login(self) end
@raise [ Auth::Unauthorized
] If the authentication failed.
@return [ Object ] The result of the block execution.
@since 2.3.0
# File lib/mongo/server.rb, line 478 def handle_auth_failure! yield rescue Mongo::Error::SocketTimeoutError # possibly cluster is slow, do not give up on it raise rescue Mongo::Error::SocketError => e # non-timeout network error unknown!( generation: e.generation, service_id: e.service_id, stop_push_monitor: true, ) raise rescue Auth::Unauthorized # auth error, keep server description and topology as they are pool.disconnect! raise end
Handle handshake failure.
@since 2.7.0 @api private
# File lib/mongo/server.rb, line 455 def handle_handshake_failure! yield rescue Mongo::Error::SocketError, Mongo::Error::SocketTimeoutError => e unknown!( generation: e.generation, service_id: e.service_id, stop_push_monitor: true, ) raise end
@deprecated
# File lib/mongo/server.rb, line 150 def heartbeat_frequency cluster.heartbeat_interval end
Get a pretty printed server inspection.
@example Get the server inspection.
server.inspect
@return [ String ] The nice inspection string.
@since 2.0.0
# File lib/mongo/server.rb, line 330 def inspect "#<Mongo::Server:0x#{object_id} address=#{address.host}:#{address.port} #{status}>" end
@return [ Time | nil ] last_scan
The time when the last server scan
completed, or nil if the server has not been scanned yet.
@since 2.4.0
# File lib/mongo/server.rb, line 129 def last_scan if description && !description.config.empty? description.last_update_time else @last_scan end end
@return [ Float | nil ] last_scan_monotime
The monotonic time when the last server scan
completed, or nil if the server has not been scanned yet.
@api private
# File lib/mongo/server.rb, line 140 def last_scan_monotime if description && !description.config.empty? description.last_update_monotime else @last_scan_monotime end end
Determine if the provided tags are a subset of the server’s tags.
@example Are the provided tags a subset of the server’s tags.
server.matches_tag_set?({ 'rack' => 'a', 'dc' => 'nyc' })
@param [ Hash ] tag_set The tag set to compare to the server’s tags.
@return [ true, false ] If the provided tags are a subset of the server’s tags.
@since 2.0.0
# File lib/mongo/server.rb, line 415 def matches_tag_set?(tag_set) tag_set.keys.all? do |k| tags[k] && tags[k] == tag_set[k] end end
@api private
# File lib/mongo/server.rb, line 610 def next_connection_id @connection_id_gen.next_id end
Get the connection pool for this server.
@example Get the connection pool for the server.
server.pool
@return [ Mongo::Server::ConnectionPool
] The connection pool.
@since 2.0.0
# File lib/mongo/server.rb, line 399 def pool @pool_lock.synchronize do @pool ||= ConnectionPool.new(self, options) end end
Publishes the server opening event.
@api private
# File lib/mongo/server.rb, line 315 def publish_opening_event publish_sdam_event( Monitoring::SERVER_OPENING, Monitoring::Event::ServerOpening.new(address, cluster.topology) ) end
Restart the server monitor.
@example Restart the server monitor.
server.reconnect!
@return [ true ] Always true.
@since 2.1.0
# File lib/mongo/server.rb, line 429 def reconnect! if options[:monitoring_io] != false monitor.restart! end @connected = true end
Whether the server supports modern read retries.
@api private
# File lib/mongo/server.rb, line 500 def retry_reads? !!(features.sessions_enabled? && logical_session_timeout) end
Will writes sent to this server be retried.
@example Will writes be retried.
server.retry_writes?
@return [ true, false ] If writes will be retried.
@note Retryable
writes are only available on server versions 3.6+ and with
sharded clusters or replica sets.
@since 2.5.0
# File lib/mongo/server.rb, line 515 def retry_writes? !!(features.sessions_enabled? && logical_session_timeout && !standalone?) end
Start monitoring the server.
Used internally by the driver to add a server to a cluster while delaying monitoring until the server is in the cluster.
@api private
# File lib/mongo/server.rb, line 305 def start_monitoring publish_opening_event if options[:monitoring_io] != false monitor.run! end end
@return [ String ] String representing server status (e.g. PRIMARY).
@api private
# File lib/mongo/server.rb, line 337 def status case when load_balancer? 'LB' when primary? 'PRIMARY' when secondary? 'SECONDARY' when standalone? 'STANDALONE' when arbiter? 'ARBITER' when ghost? 'GHOST' when other? 'OTHER' when mongos? 'MONGOS' when unknown? 'UNKNOWN' else # Since the summary method is often used for debugging, do not raise # an exception in case none of the expected types matched nil end end
@note This method is experimental and subject to change.
@api experimental @since 2.7.0
# File lib/mongo/server.rb, line 368 def summary status = self.status || '' if replica_set_name status += " replica_set=#{replica_set_name}" end unless monitor&.running? status += " NO-MONITORING" end if @pool status += " pool=#{@pool.summary}" end address_bit = if address "#{address.host}:#{address.port}" else 'nil' end "#<Server address=#{address_bit} #{status}>" end
Marks server unknown and publishes the associated SDAM event (server description changed).
If the generation is passed in options, the server will only be marked unknown if the passed generation is no older than the current generation of the server’s connection pool.
@param [ Hash ] options Options
.
@option options [ Integer ] :generation Connection
pool generation of
the connection that was used for the operation that produced the error.
@option options [ true | false ] :keep_connection_pool Usually when the
new server description is unknown, the connection pool on the respective server is cleared. Set this option to true to keep the existing connection pool (required when handling not master errors on 4.2+ servers).
@option options [ Object ] :service_id Discard state for the specified
service id only.
@option options [ TopologyVersion
] :topology_version Topology version
of the error response that is causing the server to be marked unknown.
@option options [ true | false ] :stop_push_monitor Whether to stop
the PushMonitor associated with the server, if any.
@option options [ Object ] :service_id Discard state for the specified
service id only.
@since 2.4.0, SDAM events are sent as of version 2.7.0
# File lib/mongo/server.rb, line 545 def unknown!(options = {}) if load_balancer? # When the client is in load-balanced topology, servers (the one and # only that can be) starts out as a load balancer and stays as a # load balancer indefinitely. As such it is not marked unknown. # # However, this method also clears connection pool for the server # when the latter is marked unknown, and this part needs to happen # when the server is a load balancer. if service_id = options[:service_id] pool.disconnect!(service_id: service_id) elsif Lint.enabled? raise Error::LintError, 'Load balancer was asked to be marked unknown without a service id' end return end if options[:generation] && options[:generation] < pool.generation return end if options[:topology_version] && description.topology_version && !options[:topology_version].gt?(description.topology_version) then return end if options[:stop_push_monitor] monitor&.stop_push_monitor! end # SDAM flow will update description on the server without in-place # mutations and invoke SDAM transitions as needed. config = {} if options[:service_id] config['serviceId'] = options[:service_id] end if options[:topology_version] config['topologyVersion'] = options[:topology_version] end new_description = Description.new(address, config, load_balancer: load_balancer?, force_load_balancer: options[:connect] == :load_balanced, ) cluster.run_sdam_flow(description, new_description, options) end
@api private
# File lib/mongo/server.rb, line 593 def update_description(description) @description = description end
@api private
# File lib/mongo/server.rb, line 615 def update_last_scan @last_scan = Time.now @last_scan_monotime = Utils.monotonic_time end
Execute a block of code with a connection, that is checked out of the server’s pool and then checked back in.
@example Send a message with the connection.
server.with_connection do |connection| connection.dispatch([ command ]) end
@return [ Object ] The result of the block execution.
@since 2.3.0
# File lib/mongo/server.rb, line 447 def with_connection(service_id: nil, &block) pool.with_connection(service_id: service_id, &block) end