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

Class: Mongo::Monitoring::Event::Cmap::ConnectionClosed

Inherits:

Base

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

Defined in:

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

Overview

Event published when a connection is closed.

Constant Summarycollapse

STALE =

Returns STALE Indicates that the connection was closed due to it being stale.

:stale

IDLE =

Returns IDLE Indicates that the connection was closed due to it being idle.

:idle

ERROR =

Returns ERROR Indicates that the connection was closed due to it experiencing an error.

:error

POOL_CLOSED =

Returns POOL_CLOSED Indicates that the connection was closed due to the pool already being closed.

:pool_closed

HANDSHAKE_FAILED =

Returns HANDSHAKE_FAILED Indicates that the connection was closed due to the connection handshake failing.

:handshake_failed

UNKNOWN =

Returns UNKNOWN Indicates that the connection was closed for an unknown reason.

:unknown

Instance Attribute Summary collapse

• #address ⇒ Mongo::Address readonly
  Address The address of the server the pool’s connections will connect to.
• #connection_id ⇒ Integer readonly
  Connection_id The ID of the connection.
• #reason ⇒ Symbol readonly
  Reason The reason why the connection was closed.

Instance Method Summarycollapse

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

Constructor Details

#initialize(address, id, reason) ⇒ ConnectionClosed

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.

#connection_id ⇒ Integer

Returns connection_id The ID of the connection.

#reason ⇒ Symbol

Returns reason The reason why the connection was closed.

Instance Method Details

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.