ConnectionCreated — Documentation by YARD 0.9.37 (original) (raw)
Class: Mongo::Monitoring::Event::Cmap::ConnectionCreated
Inherits:
- Object
- Event::Base
- Base
- Mongo::Monitoring::Event::Cmap::ConnectionCreated show all
Defined in:
lib/mongo/monitoring/event/cmap/connection_created.rb
Overview
Event published when a connection is created.
Instance Attribute Summary collapse
- #address ⇒ Mongo::Address readonly
Address The address of the server the connection will connect to. - #connection_id ⇒ Integer readonly
Connection_id The ID of the connection.
Instance Method Summarycollapse
- #initialize(address, id) ⇒ ConnectionCreated constructor private
Create the event. - #summary ⇒ String
Returns a concise yet useful summary of the event.
Constructor Details
#initialize(address, id) ⇒ ConnectionCreated
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 | # File 'lib/mongo/monitoring/event/cmap/connection_created.rb', line 46 def initialize(address, id) @address = address @connection_id = id end |
|---|
Instance Attribute Details
#address ⇒ Mongo::Address
Returns address The address of the server the connection will connect to.
| 32 33 34 | # File 'lib/mongo/monitoring/event/cmap/connection_created.rb', line 32 def address @address end |
|---|
#connection_id ⇒ Integer
Returns connection_id The ID of the connection.
| 37 38 39 | # File 'lib/mongo/monitoring/event/cmap/connection_created.rb', line 37 def connection_id @connection_id 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/connection_created.rb', line 59 def summary "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " + "address=#{address} connection_id=#{connection_id}>" end |
|---|