Class: Mongo::ServerSelector::Nearest

Inherits:
Object
  • Object
show all
Includes:
Selectable
Defined in:
lib/mongo/server_selector/nearest.rb

Overview

Encapsulates specifications for selecting near servers given a list

of candidates.

Since:

  • 2.0.0

Constant Summary collapse

SERVER_FORMATTED_NAME =

Name of the this read preference in the server’s format.

Since:

  • 2.5.0

'nearest'.freeze

Instance Attribute Summary

Attributes included from Selectable

#max_staleness, #options, #tag_sets

Instance Method Summary collapse

Methods included from Selectable

#==, #candidates, #initialize, #inspect, #local_threshold, #select_server, #server_selection_timeout

Instance Method Details

#name ⇒ Symbol

Get the name of the server mode type.

Examples:

Get the name of the server mode for this preference.

preference.name

Returns:

Since:

  • 2.0.0



38
39
40
 
# File 'lib/mongo/server_selector/nearest.rb', line 38

def name
  :nearest
end

#slave_ok? ⇒ true

Whether the slaveOk bit should be set on wire protocol messages.

I.e. whether the operation can be performed on a secondary server.

Returns:

  • (true) —

    true

Since:

  • 2.0.0



48
49
50
 
# File 'lib/mongo/server_selector/nearest.rb', line 48

def slave_ok?
  true
end

#tags_allowed? ⇒ true

Whether tag sets are allowed to be defined for this server preference.

Returns:

  • (true) —

    true

Since:

  • 2.0.0



57
58
59
 
# File 'lib/mongo/server_selector/nearest.rb', line 57

def tags_allowed?
  true
end

#to_mongos ⇒ Hash Also known as: to_doc

Convert this server preference definition into a format appropriate

for a mongos server.

Examples:

Convert this server preference definition into a format

for mongos.
preference = Mongo::ServerSelector::Nearest.new
preference.to_mongos

Returns:

  • (Hash) —

    The server preference formatted for a mongos server.

Since:

  • 2.0.0



72
73
74
75
76
77
 
# File 'lib/mongo/server_selector/nearest.rb', line 72

def to_mongos
  @doc ||= (preference = { :mode => SERVER_FORMATTED_NAME }
    preference.merge!({ :tags => tag_sets }) unless tag_sets.empty?
    preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness
    preference)
end