session_cluster_mismatched.rb

# frozen_string_literal: true
# rubocop:todo all

# Copyright (C) 2017-2025 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.

module Mongo
  class Error

    # Error indicating that the session was retrieved from a client with a
    # different cluster than that of the client through which it is currently being used.
    class SessionClusterMismatched < InvalidSession

      # Create the new exception.
      #
      # @example Create the new exception.
      #   SessionClusterMismatched.new
      def initialize
        super('The configured cluster of the client used to create this session does not match that ' +
                'of the client owning this operation. Please only use this session for operations ' +
                'through its parent client.')
      end
    end
  end
end