Class: Mongo::Monitoring::Event::Cmap::ConnectionCheckedOut

Inherits:
Base
  • Object
show all
Defined in:
build/ruby-driver-v2.17/lib/mongo/monitoring/event/cmap/connection_checked_out.rb

Overview

Event published when a connection is successfully checked out out of a pool.

Since:

  • 2.9.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address, id, pool) ⇒ ConnectionCheckedOut

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.

Examples:

Create the event.

ConnectionCheckedOut.new(address, id, pool)

Since:

  • 2.9.0



53
54
55
56
57
# File 'build/ruby-driver-v2.17/lib/mongo/monitoring/event/cmap/connection_checked_out.rb', line 53

def initialize(address, id, pool)
  @address = address
  @connection_id = id
  @pool = pool
end

Instance Attribute Details

#addressMongo::Address (readonly)

Returns address The address of the server that the connection will connect to.

Returns:

  • (Mongo::Address)

    address The address of the server that the connection will connect to.

Since:

  • 2.9.0



32
33
34
# File 'build/ruby-driver-v2.17/lib/mongo/monitoring/event/cmap/connection_checked_out.rb', line 32

def address
  @address
end

#connection_idInteger (readonly)

Returns connection_id The ID of the connection.

Returns:

  • (Integer)

    connection_id The ID of the connection.

Since:

  • 2.9.0



37
38
39
# File 'build/ruby-driver-v2.17/lib/mongo/monitoring/event/cmap/connection_checked_out.rb', line 37

def connection_id
  @connection_id
end

#poolMongo::Server::ConnectionPool (readonly)

was checked out from.

Returns:

Since:

  • 2.11.0



44
45
46
# File 'build/ruby-driver-v2.17/lib/mongo/monitoring/event/cmap/connection_checked_out.rb', line 44

def pool
  @pool
end

Instance Method Details

#summaryString

Note:

This method is experimental and subject to change.

Returns a concise yet useful summary of the event.

Returns:

  • (String)

    String summary of the event.

Since:

  • 2.9.0



67
68
69
70
# File 'build/ruby-driver-v2.17/lib/mongo/monitoring/event/cmap/connection_checked_out.rb', line 67

def summary
  "#<#{self.class.name.sub(/^Mongo::Monitoring::Event::Cmap::/, '')} " +
      "address=#{address} connection_id=#{connection_id} pool=0x#{pool.object_id}>"
end