Class: Mongo::Server::Monitor::Connection Private
- Inherits:
-
ConnectionCommon
- Object
- ConnectionCommon
- Mongo::Server::Monitor::Connection
- Includes:
- Loggable
- Defined in:
- build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
This class models the monitor connections and their behavior.
Direct Known Subclasses
Constant Summary
Constants included from Loggable
Instance Attribute Summary collapse
-
#address ⇒ Mongo::Address
readonly
private
Address The address to connect to.
-
#options ⇒ Hash
readonly
private
Options The passed in options.
- #server_connection_id ⇒ Object readonly private
Attributes inherited from ConnectionCommon
Instance Method Summary collapse
-
#check_document ⇒ BSON::Document
private
Build a document that should be used for connection check.
-
#connect! ⇒ true
private
Establishes a network connection to the target address.
-
#disconnect!(options = nil) ⇒ true
private
Disconnect the connection.
-
#dispatch(message) ⇒ Protocol::Message
private
Sends a message and returns the result.
-
#dispatch_bytes(bytes, **opts) ⇒ Protocol::Message
private
Sends a preserialized message and returns the result.
-
#handshake! ⇒ BSON::Document
private
Send handshake command to connected host and validate the response.
-
#initialize(address, options = {}) ⇒ Connection
constructor
private
Creates a new connection object to the specified target address with the specified options.
- #read_response(**opts) ⇒ Object private
-
#socket_timeout ⇒ Float
private
Returns the monitoring socket timeout.
- #write_bytes(bytes) ⇒ Object private
Methods included from Loggable
#log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger
Methods inherited from ConnectionCommon
#connected?, #handshake_command, #handshake_document
Constructor Details
#initialize(address, options = {}) ⇒ Connection
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.
Monitoring connections do not authenticate.
Creates a new connection object to the specified target address with the specified options.
The constructor does not perform any I/O (and thus does not create sockets nor handshakes); call connect! method on the connection object to create the network connection.
58 59 60 61 62 63 64 65 66 67 68 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 58 def initialize(address, = {}) @address = address @options = .dup.freeze unless @app_metadata = [:app_metadata] raise ArgumentError, 'App metadata is required' end @socket = nil @pid = Process.pid @compressor = nil @hello_ok = false end |
Instance Attribute Details
#address ⇒ Mongo::Address (readonly)
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.
Returns address The address to connect to.
74 75 76 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 74 def address @address end |
#options ⇒ Hash (readonly)
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.
Returns options The passed in options.
71 72 73 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 71 def @options end |
#server_connection_id ⇒ Object (readonly)
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.
89 90 91 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 89 def server_connection_id @server_connection_id end |
Instance Method Details
#check_document ⇒ BSON::Document
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.
Build a document that should be used for connection check.
228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 228 def check_document server_api = @app_metadata.server_api || [:server_api] if hello_ok? || server_api doc = HELLO_DOC if server_api doc = doc.merge(Utils.transform_server_api(server_api)) end doc else LEGACY_HELLO_DOC end end |
#connect! ⇒ true
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.
This method mutates the connection class by setting a socket if one previously did not exist.
Establishes a network connection to the target address.
If the connection is already established, this method does nothing.
157 158 159 160 161 162 163 164 165 166 167 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 157 def connect! if @socket raise ArgumentError, 'Monitoring connection already connected' end @socket = add_server_diagnostics do address.socket(socket_timeout, .merge( connection_address: address, monitor: true)) end true end |
#disconnect!(options = nil) ⇒ true
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.
This method mutates the connection by setting the socket to nil if the closing succeeded.
This method accepts an options argument for compatibility with Server::Connections. However, all options are ignored.
Disconnect the connection.
183 184 185 186 187 188 189 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 183 def disconnect!( = nil) if socket socket.close rescue nil @socket = nil end true end |
#dispatch(message) ⇒ Protocol::Message
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.
Sends a message and returns the result.
96 97 98 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 96 def dispatch() dispatch_bytes(.serialize.to_s) end |
#dispatch_bytes(bytes, **opts) ⇒ Protocol::Message
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.
Sends a preserialized message and returns the result.
108 109 110 111 112 113 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 108 def dispatch_bytes(bytes, **opts) write_bytes(bytes) read_response( socket_timeout: opts[:read_socket_timeout], ) end |
#handshake! ⇒ BSON::Document
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.
Send handshake command to connected host and validate the response.
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 196 def handshake! command = handshake_command( handshake_document( @app_metadata, server_api: [:server_api] ) ) payload = command.serialize.to_s = dispatch_bytes(payload) result = Operation::Result.new() result.validate! reply = result.documents.first set_compressor!(reply) set_hello_ok!(reply) @server_connection_id = reply['connectionId'] reply rescue => exc msg = "Failed to handshake with #{address}" Utils.warn_bg_exception(msg, exc, logger: [:logger], log_prefix: [:log_prefix], bg_error_backtrace: [:bg_error_backtrace], ) raise end |
#read_response(**opts) ⇒ Object
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.
129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 129 def read_response(**opts) unless connected? raise ArgumentError, "Trying to read on an unconnected connection #{self}" end add_server_connection_id do add_server_diagnostics do Protocol::Message.deserialize(socket, Protocol::Message::MAX_MESSAGE_SIZE, nil, **opts) end end end |
#socket_timeout ⇒ Float
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.
Returns the monitoring socket timeout.
Note that monitoring connections use the connect timeout value as the socket timeout value. See the Server Discovery and Monitoring specification for details.
85 86 87 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 85 def socket_timeout [:connect_timeout] || Server::CONNECT_TIMEOUT end |
#write_bytes(bytes) ⇒ Object
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.
115 116 117 118 119 120 121 122 123 124 125 |
# File 'build/ruby-driver-v2.17/lib/mongo/server/monitor/connection.rb', line 115 def write_bytes(bytes) unless connected? raise ArgumentError, "Trying to dispatch on an unconnected connection #{self}" end add_server_connection_id do add_server_diagnostics do socket.write(bytes) end end end |