Class: Mongo::Monitoring::Event::Cmap::ConnectionReady

Inherits:
Base show all
Defined in:
lib/mongo/monitoring/event/cmap/connection_ready.rb

Overview

Event published when a connection is ready to be used for operations.

Since:

  • 2.9.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address, id) ⇒ ConnectionReady

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.

Examples:

Create the event.

ConnectionReady.new(address, id)

Since:

  • 2.9.0



43
44
45
46
 
# File 'lib/mongo/monitoring/event/cmap/connection_ready.rb', line 43

def initialize(address, id)
  @address = address
  @connection_id = id
end

Instance Attribute Details

#address ⇒ Mongo::Address (readonly)

Returns address The address of the server the connection is connected to.

Returns:

  • (Mongo::Address) —

    address The address of the server the connection is connected to.

Since:

  • 2.9.0



29
30
31
 
# File 'lib/mongo/monitoring/event/cmap/connection_ready.rb', line 29

def address
  @address
end

#connection_id ⇒ Integer (readonly)

Returns connection_id The ID of the connection.

Returns:

  • (Integer) —

    connection_id The ID of the connection.

Since:

  • 2.9.0



34
35
36
 
# File 'lib/mongo/monitoring/event/cmap/connection_ready.rb', line 34

def connection_id
  @connection_id
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.9.0



56
57
58
59
 
# File 'lib/mongo/monitoring/event/cmap/connection_ready.rb', line 56

def summary
  "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
      "address=#{address} connection_id=#{connection_id}>"
end