Contents

# Copyright (C) 2014-2015 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.

require 'mongo/server_selector/selectable'
require 'mongo/server_selector/nearest'
require 'mongo/server_selector/primary'
require 'mongo/server_selector/primary_preferred'
require 'mongo/server_selector/secondary'
require 'mongo/server_selector/secondary_preferred'

module Mongo

  # Functionality for getting an object able to select a server, given a preference.
  #
  # @since 2.0.0
  module ServerSelector
    extend self

    # Hash lookup for the selector classes based off the symbols
    #   provided in configuration.
    #
    # @since 2.0.0
    PREFERENCES = {
        nearest: Nearest,
        primary: Primary,
        primary_preferred: PrimaryPreferred,
        secondary: Secondary,
        secondary_preferred: SecondaryPreferred
    }.freeze

    # Create a server selector object.
    #
    # @example Get a server selector object for selecting a secondary with
    #   specific tag sets.
    #   Mongo::ServerSelector.get({ :mode => :secondary, :tag_sets => [{'dc' => 'nyc'}] })
    #
    # @param [ Hash ] preference The server preference.
    # @param [ Hash ] options The preference options.
    #
    # @option preference :mode [ Symbol ] The preference mode.
    # @option preference :tag_sets [ Array<Hash> ] The tag sets.
    #
    # @since 2.0.0
    def get(preference = {}, options = {})
      PREFERENCES.fetch(preference[:mode] || :primary).new(
        preference[:tag_sets] || [],
        options
      )
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
mongo-2.1.0.beta	lib/mongo/server_selector.rb
mongo-2.0.6	lib/mongo/server_selector.rb
mongo-2.0.5	lib/mongo/server_selector.rb
mongo-2.0.4	lib/mongo/server_selector.rb
mongo-2.0.3	lib/mongo/server_selector.rb