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

Class: Mongo::Monitoring::Event::Cmap::PoolReady

Inherits:

Base

Defined in:

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

Overview

Event published when a connection pool is marked ready.

Instance Attribute Summary collapse

Instance Method Summarycollapse

Constructor Details

#initialize(address, options, pool) ⇒ PoolReady

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.

46 47 48 49 50 # File 'lib/mongo/monitoring/event/cmap/pool_ready.rb', line 46 def initialize(address, options, pool) @address = address @options = options.dup.freeze @pool = pool end

Instance Attribute Details

#addressMongo::Address

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

28 29 30 # File 'lib/mongo/monitoring/event/cmap/pool_ready.rb', line 28 def address @address end

#options ⇒ Hash

Returns options Options specified for pool creation.

31 32 33 # File 'lib/mongo/monitoring/event/cmap/pool_ready.rb', line 31 def options @options end

Instance Method Details

#summary ⇒ String

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.

59 60 61 62 # File 'lib/mongo/monitoring/event/cmap/pool_ready.rb', line 59 def summary "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " + "address=#{address} options=#{options} pool=0x#{pool.object_id}>" end