lib/mongo/error/max_message_size.rb
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2014-2020 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
# Exception that is raised when trying to send a message that exceeds max
# message size.
#
# @since 2.0.0
class MaxMessageSize < Error
# The message is constant.
#
# @since 2.0.0
MESSAGE = "Message exceeds allowed max message size.".freeze
# Instantiate the new exception.
#
# @example Instantiate the exception.
# Mongo::Error::MaxMessageSize.new(max)
#
# @param [ Integer ] max_size The maximum message size.
#
# @since 2.0.0
def initialize(max_size = nil)
super(max_size ? MESSAGE + " The max is #{max_size}." : MESSAGE)
end
end
end
end