ServerHeartbeatStarted — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Monitoring::Event::ServerHeartbeatStarted

Inherits:

Event::Base

• Object
• Event::Base
• Mongo::Monitoring::Event::ServerHeartbeatStarted show all

Defined in:

lib/mongo/monitoring/event/server_heartbeat_started.rb

Overview

Event fired when a server heartbeat is dispatched.

Instance Attribute Summary collapse

• #address ⇒ Address readonly
  Address The server address.

Instance Method Summarycollapse

• #awaited? ⇒ true | false
  Whether the heartbeat was awaited.
• #initialize(address, awaited: false) ⇒ ServerHeartbeatStarted constructor private
  Create the event.
• #summary ⇒ String
  Returns a concise yet useful summary of the event.

Constructor Details

#initialize(address, awaited: false) ⇒ ServerHeartbeatStarted

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Create the event.

Instance Attribute Details

#address ⇒ Address

Returns address The server address.

Instance Method Details

#awaited? ⇒ true | false

Returns Whether the heartbeat was awaited.

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.