123456789_123456789_123456789_123456789_123456789_

Class: Mongo::Monitoring::Event::ServerHeartbeatSucceeded

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Mongo::Event::Base
Instance Chain:
self, ::Mongo::Event::Base
Inherits: Mongo::Event::Base
Defined in: lib/mongo/monitoring/event/server_heartbeat_succeeded.rb

Overview

::Mongo::Monitoring::Event fired when a server heartbeat is dispatched.

Since:

  • 2.7.0

Class Method Summary

Instance Attribute Summary

Instance Method Summary

::Mongo::Event::Base - Inherited

#summary

Returns a concise yet useful summary of the event.
#short_class_name

Instance Attribute Details

#address ⇒ Address (readonly)

Returns:

  • (Address) —

    address The server address.

Since:

  • 2.7.0

[ GitHub ] 

  


# File 'lib/mongo/monitoring/event/server_heartbeat_succeeded.rb', line 50



attr_reader :address


  








  

    #awaited?  ⇒ true | false  (readonly)
  



  

    
  





  
Returns:


    
  
  • 
    (true | false)
—    
    

    Whether the heartbeat was awaited.
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.7.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/monitoring/event/server_heartbeat_succeeded.rb', line 59



def awaited?
  @awaited
end


  








  

    #duration   (readonly)
  



  

    

Alias for #round_trip_time.


  



  [ GitHub ]


  

  


# File 'lib/mongo/monitoring/event/server_heartbeat_succeeded.rb', line 56



alias :duration :round_trip_time


  








  

    #round_trip_time  ⇒ Float  (readonly)
    Also known as: #duration
  



  

    
  





  
Returns:


    
  
  • 
    (Float)
—    
    

    round_trip_time Duration of hello call in seconds.
    

    
  
    • 



Since:


    
  
  • 
    
    

    2.7.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/monitoring/event/server_heartbeat_succeeded.rb', line 53



attr_reader :round_trip_time


  








  

    #started_event  ⇒ Monitoring::Event::ServerHeartbeatStarted  (readonly)
  



  

    
  





  
Returns:



Since:


    
  
  • 
    
    

    2.7.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/monitoring/event/server_heartbeat_succeeded.rb', line 67



attr_reader :started_event


  







Instance Method Details



  

    #summary  ⇒ String 
  



  

    
  

    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.7.0
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongo/monitoring/event/server_heartbeat_succeeded.rb', line 77



def summary
  "#<#{short_class_name}" +
  " address=#{address}>"
end