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

Class: Mongo::Monitoring::Event::Cmap::ConnectionCheckOutStarted

Inherits:

Base

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

Defined in:

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

Overview

Event published when a thread begins attempting to check a connection out of a pool.

Instance Attribute Summary collapse

• #address ⇒ Mongo::Address readonly
  Address The address of the server that the connection will connect to.

Instance Method Summarycollapse

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

Constructor Details

#initialize(address) ⇒ ConnectionCheckOutStarted

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.

Instance Method Details

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.