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

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

Inherits:

Base

• Object
• Event::Base
• Base
• Mongo::Monitoring::Event::Cmap::PoolCleared show all

Defined in:

lib/mongo/monitoring/event/cmap/pool_cleared.rb

Overview

Event published when a connection pool is cleared.

Instance Attribute Summary collapse

• #address ⇒ Mongo::Address readonly
  Address The address of the server the pool’s connections will connect to.
• #options ⇒ Hash readonly
  Options The options.
• #service_id ⇒ nil | Object readonly
  The service id, if any.

Instance Method Summarycollapse

• #initialize(address, service_id: nil, interrupt_in_use_connections: nil) ⇒ PoolCleared constructor private
  Create the event.
• #summary ⇒ String
  Returns a concise yet useful summary of the event.

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.

Instance Attribute Details

#address ⇒ Mongo::Address

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

#options ⇒ Hash

Returns options The options.

#service_id ⇒ nil | Object

Returns The service id, if any.

Instance Method Details

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.