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

Class: Mongo::Monitoring::Event::Cmap::ConnectionCheckedOut

Inherits:

Base

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

Defined in:

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

Overview

Event published when a connection is successfully checked out out of a pool.

Instance Attribute Summary collapse

• #address ⇒ Mongo::Address readonly
  Address The address of the server that the connection will connect to.
• #connection_id ⇒ Integer readonly
  Connection_id The ID of the connection.
• #pool ⇒ Mongo::Server::ConnectionPool readonly
  was checked out from.

Instance Method Summarycollapse

• #initialize(address, id, pool) ⇒ ConnectionCheckedOut constructor private
  Create the event.
• #summary ⇒ String
  Returns a concise yet useful summary of the event.

Constructor Details

#initialize(address, id, pool) ⇒ ConnectionCheckedOut

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 that the connection will connect to.

#connection_id ⇒ Integer

Returns connection_id The ID of the connection.

Instance Method Details

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.