Class: Mongo::Server::Connection
- Inherits:
-
ConnectionBase
- Object
- ConnectionCommon
- ConnectionBase
- Mongo::Server::Connection
- Extended by:
- Forwardable
- Includes:
- Id, Monitoring::Publishable, Retryable
- Defined in:
- build/ruby-driver-master/lib/mongo/server/connection.rb
Overview
This class models the socket connections for servers and their behavior.
Constant Summary collapse
- PING =
Deprecated.
No longer necessary with Server Selection specification.
The ping command.
{ :ping => 1 }.freeze
- PING_OP_MSG =
Deprecated.
No longer necessary with Server Selection specification.
The ping command for an OP_MSG (server versions >= 3.6).
{ :ping => 1, '$db' => Database::ADMIN }.freeze
- PING_MESSAGE =
Deprecated.
No longer necessary with Server Selection specification.
Ping message.
Protocol::Query.new(Database::ADMIN, Database::COMMAND, PING, :limit => -1)
- PING_OP_MSG_MESSAGE =
Deprecated.
No longer necessary with Server Selection specification.
Ping message as an OP_MSG (server versions >= 3.6).
Protocol::Msg.new([], {}, PING_OP_MSG)
- PING_BYTES =
Deprecated.
No longer necessary with Server Selection specification.
The ping message as raw bytes.
PING_MESSAGE.serialize.to_s.freeze
- PING_OP_MSG_BYTES =
Deprecated.
No longer necessary with Server Selection specification.
The ping OP_MSG message as raw bytes (server versions >= 3.6).
PING_OP_MSG_MESSAGE.serialize.to_s.freeze
Constants included from Loggable
Constants inherited from ConnectionBase
Mongo::Server::ConnectionBase::DEFAULT_MAX_BSON_OBJECT_SIZE, Mongo::Server::ConnectionBase::MAX_BSON_COMMAND_OVERHEAD, Mongo::Server::ConnectionBase::REDUCED_MAX_BSON_SIZE
Instance Attribute Summary collapse
-
#global_id ⇒ Integer
readonly
across all connections.
-
#id ⇒ Integer
readonly
across connections to the same server object.
-
#last_checkin ⇒ Time
readonly
The last time the connection was checked back into a pool.
Attributes included from Monitoring::Publishable
Attributes inherited from ConnectionBase
#description, #options, #server
Attributes inherited from ConnectionCommon
Instance Method Summary collapse
-
#closed? ⇒ true | false
Whether the connection was closed.
-
#connect! ⇒ true
Establishes a network connection to the target address.
-
#connection_pool ⇒ Object
private
The connection pool from which this connection was created.
-
#disconnect!(options = nil) ⇒ true
Disconnect the connection.
- #error? ⇒ Boolean private
-
#initialize(server, options = {}) ⇒ Connection
constructor
private
Creates a new connection object to the specified target address with the specified options.
-
#ping ⇒ true, false
deprecated
Deprecated.
No longer necessary with Server Selection specification.
-
#record_checkin! ⇒ self
Record the last checkin time.
-
#socket_timeout ⇒ Float
(also: #timeout)
Get the timeout to execute an operation on a socket.
Methods included from Id
Methods included from Retryable
#legacy_write_with_retry, #nro_write_with_retry, #read_with_one_retry, #read_with_retry, #read_with_retry_cursor, #write_with_retry
Methods included from Monitoring::Publishable
#publish_cmap_event, #publish_event, #publish_sdam_event
Methods included from Loggable
#log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger
Methods inherited from ConnectionBase
#app_metadata, #dispatch, #generation, #service_id
Methods inherited from ConnectionCommon
#connected?, #handshake_command, #handshake_document
Constructor Details
#initialize(server, 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.
Connection must never be directly instantiated outside of a Server.
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, handshakes nor authenticates); call connect! method on the connection object to create the network connection.
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 103 def initialize(server, = {}) if server.load_balancer? && [:generation] raise ArgumentError, "Generation cannot be set when server is a load balancer" end @id = server.next_connection_id @global_id = self.class.next_id @monitoring = server.monitoring @options = .freeze @server = server @socket = nil @last_checkin = nil @auth_mechanism = nil @pid = Process.pid publish_cmap_event( Monitoring::Event::Cmap::ConnectionCreated.new(address, id) ) end |
Instance Attribute Details
#global_id ⇒ Integer (readonly)
across all connections.
136 137 138 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 136 def global_id @global_id end |
#id ⇒ Integer (readonly)
across connections to the same server object.
132 133 134 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 132 def id @id end |
#last_checkin ⇒ Time (readonly)
Returns The last time the connection was checked back into a pool.
126 127 128 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 126 def last_checkin @last_checkin end |
Instance Method Details
#closed? ⇒ true | false
Whether the connection was closed.
Closed connections should no longer be used. Instead obtain a new connection from the connection pool.
154 155 156 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 154 def closed? !!@closed end |
#connect! ⇒ true
This method mutates the connection object 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.
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 176 def connect! if error? raise Error::ConnectionPerished, "Connection #{generation}:#{id} for #{address.seed} is perished. Reconnecting closed or errored connections is no longer supported" end if closed? raise Error::ConnectionPerished, "Connection #{generation}:#{id} for #{address.seed} is closed. Reconnecting closed or errored connections is no longer supported" end unless @socket # When @socket is assigned, the socket should have handshaken and # authenticated and be usable. @socket, @description, @compressor = do_connect if server.load_balancer? if Lint.enabled? unless service_id raise Error::InternalDriverError, "The connection is to a load balancer and it must have service_id set here, but does not" end end @generation = connection_pool.generation_manager.generation(service_id: service_id) end publish_cmap_event( Monitoring::Event::Cmap::ConnectionReady.new(address, id) ) @close_event_published = false end true end |
#connection_pool ⇒ 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.
The connection pool from which this connection was created. May be nil.
142 143 144 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 142 def connection_pool [:connection_pool] end |
#disconnect!(options = nil) ⇒ true
Once a connection is disconnected, it should no longer be used. A new connection should be obtained from the connection pool which will either return a ready connection or create a new connection. If linting is enabled, reusing a disconnected connection will raise Error::LintError. If linting is not enabled, a warning will be logged.
This method mutates the connection object by setting the socket to nil if the closing succeeded.
Disconnect the connection.
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 248 def disconnect!( = nil) # Note: @closed may be true here but we also may have a socket. # Check the socket and not @closed flag. @auth_mechanism = nil @last_checkin = nil if socket socket.close rescue nil @socket = nil end @closed = true # To satisfy CMAP spec tests, publish close events even if the # socket was never connected (and thus the ready event was never # published). But track whether we published close event and do not # publish it multiple times, unless the socket was reconnected - # in that case publish the close event once per socket close. unless @close_event_published reason = && [:reason] publish_cmap_event( Monitoring::Event::Cmap::ConnectionClosed.new( address, id, reason, ), ) @close_event_published = true end true end |
#error? ⇒ Boolean
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.
159 160 161 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 159 def error? !!@error end |
#ping ⇒ true, false
No longer necessary with Server Selection specification.
This uses a pre-serialized ping message for optimization.
Ping the connection to see if the server is responding to commands. This is non-blocking on the server side.
292 293 294 295 296 297 298 299 300 301 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 292 def ping bytes = features.op_msg_enabled? ? PING_OP_MSG_BYTES : PING_BYTES ensure_connected do |socket| reply = add_server_diagnostics do socket.write(bytes) Protocol::Message.deserialize(socket, ) end reply.documents[0][Operation::Result::OK] == 1 end end |
#record_checkin! ⇒ self
Record the last checkin time.
322 323 324 325 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 322 def record_checkin! @last_checkin = Time.now self end |
#socket_timeout ⇒ Float Also known as: timeout
Get the timeout to execute an operation on a socket.
308 309 310 |
# File 'build/ruby-driver-master/lib/mongo/server/connection.rb', line 308 def socket_timeout @timeout ||= [:socket_timeout] end |