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

Class: Mongo::Monitoring::Event::Cmap::ConnectionCheckOutFailed

Inherits:

Base

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

Defined in:

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

Overview

Event published when a connection is unable to be checked out of a pool.

Constant Summarycollapse

POOL_CLOSED =

Returns POOL_CLOSED Indicates that the connection check out failed due to the pool already being closed.

:pool_closed

TIMEOUT =

Returns TIMEOUT Indicates that the connection check out failed due to the timeout being reached before a connection became available.

:timeout

CONNECTION_ERROR =

Returns CONNECTION_ERROR Indicates that the connection check out failed due to an error encountered while setting up a new connection.

:connection_error

Instance Attribute Summary collapse

• #address ⇒ Mongo::Address readonly
  Address The address of the server the connection would have connected to.
• #reason ⇒ Symbol readonly
  Reason The reason a connection was unable to be acquired.

Instance Method Summarycollapse

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

Constructor Details

#initialize(address, reason) ⇒ ConnectionCheckOutFailed

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 connection would have connected to.

#reason ⇒ Symbol

Returns reason The reason a connection was unable to be acquired.

Instance Method Details

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.