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

Class: Mongo::Monitoring::Event::ServerHeartbeatFailed

Inherits:

Event::Base

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

Defined in:

lib/mongo/monitoring/event/server_heartbeat_failed.rb

Overview

Event fired when a server heartbeat is dispatched.

Instance Attribute Summary collapse

• #address ⇒ Address readonly
  Address The server address.
• #error ⇒ Exception (also: #failure) readonly
  Error The exception that occurred in hello call.
• #round_trip_time ⇒ Float (also: #duration) readonly
  Round_trip_time Duration of hello call in seconds.
• #started_event ⇒ Monitoring::Event::ServerHeartbeatStarted readonly
  The corresponding started event.

Instance Method Summarycollapse

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

Constructor Details

#initialize(address, round_trip_time, error, awaited: false, started_event:) ⇒ ServerHeartbeatFailed

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.

#error ⇒ Exception Also known as:failure

Returns error The exception that occurred in hello call.

#round_trip_time ⇒ Float Also known as:duration

Returns round_trip_time Duration of hello call in seconds.

#started_event ⇒ Monitoring::Event::ServerHeartbeatStarted

Returns The corresponding started event.

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.