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

Inherits:
Event::Base
  • Object
show all
Defined in:
lib/mongo/monitoring/event/server_description_changed.rb

Overview

Event fired when a server’s description changes.

Since:

  • 2.4.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address, topology, previous_description, new_description) ⇒ ServerDescriptionChanged

Create the event.

Examples:

Create the event.

ServerDescriptionChanged.new(address, topology, previous, new)

Parameters:

Since:

  • 2.4.0



49
50
51
52
53
54
 
# File 'lib/mongo/monitoring/event/server_description_changed.rb', line 49

def initialize(address, topology, previous_description, new_description)
  @address = address
  @topology = topology
  @previous_description = previous_description
  @new_description = new_description
end

Instance Attribute Details

#address ⇒ Address (readonly)

Returns address The server address.

Returns:

  • (Address) —

    address The server address.

Since:

  • 2.4.0



25
26
27
 
# File 'lib/mongo/monitoring/event/server_description_changed.rb', line 25

def address
  @address
end

#new_description ⇒ Server::Description (readonly)

Returns new_description The new server description.

Returns:

Since:

  • 2.4.0



36
37
38
 
# File 'lib/mongo/monitoring/event/server_description_changed.rb', line 36

def new_description
  @new_description
end

#previous_description ⇒ Server::Description (readonly)

Returns previous_description The previous server description.

Returns:

Since:

  • 2.4.0



32
33
34
 
# File 'lib/mongo/monitoring/event/server_description_changed.rb', line 32

def previous_description
  @previous_description
end

#topology ⇒ Topology (readonly)

Returns topology The topology.

Returns:

  • (Topology) —

    topology The topology.

Since:

  • 2.4.0



28
29
30
 
# File 'lib/mongo/monitoring/event/server_description_changed.rb', line 28

def topology
  @topology
end

Instance Method Details

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.

Returns:

  • (String) —

    String summary of the event.

Since:

  • 2.7.0



64
65
66
67
68
69
 
# File 'lib/mongo/monitoring/event/server_description_changed.rb', line 64

def summary
  "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::/, '')}" +
  " address=#{address} topology=#{topology.summary}" +
  # TODO Add summaries to descriptions and use them here
  " prev=#{previous_description.inspect} new=#{new_description.inspect}>"
end