Class: Mongo::Monitoring::Event::Cmap::PoolCleared

Inherits:
Base show all
Defined in:
build/ruby-driver-v2.19/lib/mongo/monitoring/event/cmap/pool_cleared.rb

Overview

Event published when a connection pool is cleared.

Since:

  • 2.9.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address, service_id: nil, interrupt_in_use_connections: nil) ⇒ PoolCleared

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.

Parameters:

  • address (Address)
  • service_id (Object) (defaults to: nil) —

    The service id, if any.

  • interrupt_in_use_connections (true | false | nil) (defaults to: nil) —

    The interrupt_in_use_connections flag, if given.

Since:

  • 2.9.0



48
49
50
51
52
53
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/cmap/pool_cleared.rb', line 48

def initialize(address, service_id: nil, interrupt_in_use_connections: nil)
  @address = address
  @service_id = service_id
  @options = {}
  @options[:interrupt_in_use_connections] = interrupt_in_use_connections
end

Instance Attribute Details

#address ⇒ Mongo::Address (readonly)

Returns address The address of the server the pool’s connections will connect to.

Returns:

  • (Mongo::Address) —

    address The address of the server the pool’s connections will connect to.

Since:

  • 2.9.0



32
33
34
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/cmap/pool_cleared.rb', line 32

def address
  @address
end

#options ⇒ Hash (readonly)

Returns options The options.

Returns:

  • (Hash) —

    options The options

Since:

  • 2.9.0



38
39
40
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/cmap/pool_cleared.rb', line 38

def options
  @options
end

#service_id ⇒ nil | Object (readonly)

Returns The service id, if any.

Returns:

  • (nil | Object) —

    The service id, if any.

Since:

  • 2.9.0



35
36
37
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/cmap/pool_cleared.rb', line 35

def service_id
  @service_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



63
64
65
 
# File 'build/ruby-driver-v2.19/lib/mongo/monitoring/event/cmap/pool_cleared.rb', line 63

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