Class: Mongo::Server

# File 'lib/mongo/server.rb', line 109

attr_reader :cluster

# File 'lib/mongo/server.rb', line 261

def connectable?; end

# File 'lib/mongo/server.rb', line 320

def connected?
  @connected
end

# File 'lib/mongo/server.rb', line 123

attr_reader :description

# File 'lib/mongo/server.rb', line 130

def force_load_balancer?
  options[:connect] == :load_balanced
end

# File 'lib/mongo/server.rb', line 113

attr_reader :monitor

# File 'lib/mongo/server.rb', line 119

attr_reader :monitoring

# File 'lib/mongo/server.rb', line 116

attr_reader :options

# File 'lib/mongo/server.rb', line 543

def retry_reads?
  !!(features.sessions_enabled? && logical_session_timeout)
end

# File 'lib/mongo/server.rb', line 564

def retry_writes?
  !!(features.sessions_enabled? && logical_session_timeout && !standalone?) || load_balancer?
end

# File 'lib/mongo/server.rb', line 233

attr_reader :round_trip_time_averager

# File 'lib/mongo/server.rb', line 229

attr_reader :scan_semaphore

# File 'lib/mongo/server.rb', line 667

def clear_connection_pool(service_id: nil, interrupt_in_use_connections: false)
  @pool_lock.synchronize do
    # A server being marked unknown after it is closed is technically
    # incorrect but it does not meaningfully alter any state.
    # Because historically the driver permitted servers to be marked
    # unknown at any time, continue doing so even if the pool is closed.
    if @pool && !@pool.closed?
      @pool.disconnect!(service_id: service_id, interrupt_in_use_connections: interrupt_in_use_connections)
    end
  end
end

# File 'lib/mongo/server.rb', line 657

def clear_description
  @description = Mongo::Server::Description.new(address, {})
end

# File 'lib/mongo/server.rb', line 294

def close
  if monitor
    monitor.stop!
  end

  @connected = false

  _pool = nil
  @pool_lock.synchronize do
    _pool, @pool = @pool, nil
  end

  # TODO: change this to _pool.close in RUBY-3174.
  # Clear the pool. If the server is not unknown then the
  # pool will stay ready. Stop the background populator thread.
  _pool&.close(stay_ready: true)

  nil
end

# File 'lib/mongo/server.rb', line 181

def compressor
  if monitor
    monitor.compressor
  else
    nil
  end
end

# File 'lib/mongo/server.rb', line 275

def disconnect!
  if monitor
    monitor.stop!
  end

  @connected = false

  # The current CMAP spec requires a pool to be mostly unusable
  # if its server is unknown (or, therefore, disconnected).
  # However any outstanding operations should continue to completion,
  # and their connections need to be checked into the pool to be
  # torn down. Because of this cleanup requirement we cannot just
  # close the pool and set it to nil here, to be recreated the next
  # time the server is discovered.
  pool_internal&.clear

  true
end

# File 'lib/mongo/server.rb', line 524

def handle_auth_failure!
  yield
rescue Mongo::Error::SocketTimeoutError
  # possibly cluster is slow, do not give up on it
  raise
rescue Mongo::Error::SocketError, Auth::Unauthorized => e
  # non-timeout network error or auth error, clear the pool and mark the
  # topology as unknown
  unknown!(
    generation: e.generation,
    service_id: e.service_id,
    stop_push_monitor: true,
  )
  raise
end

# File 'lib/mongo/server.rb', line 501

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

# File 'lib/mongo/server.rb', line 159

def heartbeat_frequency
  cluster.heartbeat_interval
end

# File 'lib/mongo/server.rb', line 164

alias :heartbeat_frequency_seconds :heartbeat_frequency

# File 'lib/mongo/server.rb', line 355

def inspect
  "#<Mongo::Server:0x#{object_id} address=#{address.host}:#{address.port} #{status}>"
end

# File 'lib/mongo/server.rb', line 138

def last_scan
  if description && !description.config.empty?
    description.last_update_time
  else
    @last_scan
  end
end

# File 'lib/mongo/server.rb', line 149

def last_scan_monotime
  if description && !description.config.empty?
    description.last_update_monotime
  else
    @last_scan_monotime
  end
end

# File 'lib/mongo/server.rb', line 461

def matches_tag_set?(tag_set)
  tag_set.keys.all? do |k|
    tags[k] && tags[k] == tag_set[k]
  end
end

# File 'lib/mongo/server.rb', line 680

def next_connection_id
  @connection_id_gen.next_id
end

# File 'lib/mongo/server.rb', line 424

def pool
  if unknown?
    raise Error::ServerNotUsable, address
  end

  @pool_lock.synchronize do
    opts = connected? ? options : options.merge(populator_io: false)
    @pool ||= ConnectionPool.new(self, opts).tap do |pool|
      pool.ready
    end
  end
end

# File 'lib/mongo/server.rb', line 445

def pool_internal
  @pool_lock.synchronize do
    @pool
  end
end

# File 'lib/mongo/server.rb', line 340

def publish_opening_event
  publish_sdam_event(
    Monitoring::SERVER_OPENING,
    Monitoring::Event::ServerOpening.new(address, cluster.topology)
  )
end

# File 'lib/mongo/server.rb', line 475

def reconnect!
  if options[:monitoring_io] != false
    monitor.restart!
  end
  @connected = true
end

# File 'lib/mongo/server.rb', line 330

def start_monitoring
  publish_opening_event
  if options[:monitoring_io] != false
    monitor.run!
  end
end

# File 'lib/mongo/server.rb', line 362

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

# File 'lib/mongo/server.rb', line 393

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

# File 'lib/mongo/server.rb', line 592

def unknown!(options = {})
  pool = pool_internal

  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.
    #
    # It is possible for a load balancer server to not have a service id,
    # for example if there haven't been any successful connections yet to
    # this server, but the server can still be marked unknown if one
    # of such connections failed midway through its establishment.
    if service_id = options[:service_id]
      pool&.disconnect!(service_id: 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

# File 'lib/mongo/server.rb', line 645

def update_description(description)
  pool = pool_internal
  if pool && !description.unknown?
    pool.ready
  end
  @description = description
end

# File 'lib/mongo/server.rb', line 685

def update_last_scan
  @last_scan = Time.now
  @last_scan_monotime = Utils.monotonic_time
end

# File 'lib/mongo/server.rb', line 493

def with_connection(connection_global_id: nil, &block)
  pool.with_connection(connection_global_id: connection_global_id, &block)
end