Sha256: 2bd6a2f91bbc3a3d6b620672eb390b9d077ca54b918fea573ddebbe41e4ee6c5
Contents?: true
Size: 1.79 KB
Versions: 9
Compression:
Stored size: 1.79 KB
Contents
# Copyright (C) 2018-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 Monitoring
module Event
# Event fired when a server heartbeat is dispatched.
#
# @since 2.7.0
class ServerHeartbeatStarted < Mongo::Event::Base
# @return [ Address ] address The server address.
attr_reader :address
# @return [ true | false ] Whether the heartbeat was awaited.
def awaited?
@awaited
end
# Create the event.
#
# @example Create the event.
# ServerHeartbeatStarted.new(address)
#
# @param [ Address ] address The server address.
# @param [ true | false ] awaited Whether the heartbeat was awaited.
#
# @since 2.7.0
# @api private
def initialize(address, awaited: false)
@address = address
@awaited = !!awaited
end
# Returns a concise yet useful summary of the event.
#
# @return [ String ] String summary of the event.
#
# @note This method is experimental and subject to change.
#
# @since 2.7.0
# @api experimental
def summary
"#<#{short_class_name}" +
" address=#{address}>"
end
end
end
end
end
Version data entries
9 entries across 9 versions & 1 rubygems