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

Class: Mongo::Monitoring::Event::ServerDescriptionChanged

Inherits:

Event::Base

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

Defined in:

lib/mongo/monitoring/event/server_description_changed.rb

Overview

Event fired when a server’s description changes.

Instance Attribute Summary collapse

• #address ⇒ Address readonly
  Address The server address.
• #new_description ⇒ Server::Description readonly
  New_description The new server description.
• #previous_description ⇒ Server::Description readonly
  Previous_description The previous server description.
• #topology ⇒ Topology readonly
  Topology The topology.

Instance Method Summarycollapse

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

Constructor Details

#initialize(address, topology, previous_description, new_description, awaited: false) ⇒ ServerDescriptionChanged

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.

#new_description ⇒ Server::Description

Returns new_description The new server description.

#previous_description ⇒ Server::Description

Returns previous_description The previous server description.

#topology ⇒ Topology

Returns topology The topology.

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.