Merge branch 'check_connection'

Author: larskanis

History.md

@@ -30,7 +30,7 @@ Enhancements:
   Previously stdlib libraries `date`, `json`, `ipaddr` and `bigdecimal` were static dependencies, but now only `socket` is mandatory.
 - Improve garbage collector performance by adding write barriers to all PG classes. [#518](https://github.com/ged/ruby-pg/pull/518)
   Now they can be promoted to the old generation, which means they only get marked on major GC.
-- New method PG::Connection#check_connection to check the socket state. [#521](https://github.com/ged/ruby-pg/pull/521)
+- New method PG::Connection#check_socket to check the socket state. [#521](https://github.com/ged/ruby-pg/pull/521)
 - Update Windows fat binary gem to OpenSSL-3.1.0.
 
 Bugfixes:

ext/pg_connection.c

@@ -765,7 +765,7 @@ pgconn_conninfo( VALUE self )
  *
  * This method returns the status of the last command from memory.
  * It doesn't do any socket access hence is not suitable to test the connectivity.
- * See check_connection for a way to verify the socket state.
+ * See check_socket for a way to verify the socket state.
  *
  * Example:
  *   PG.constants.grep(/CONNECTION_/).find{|c| PG.const_get(c) == conn.status} # => :CONNECTION_OK

lib/pg/connection.rb

@@ -353,7 +353,7 @@ def ssl_attributes
 	#
 	# The method doesn't verify that the server is still responding.
 	# To verify that the communication to the server works, it is recommended to use something like <tt>conn.exec('')</tt> instead.
-	def check_connection
+	def check_socket
 		while socket_io.wait_readable(0)
 			consume_input
 		end
@@ -831,7 +831,7 @@ def new(*args)
 		# [+PQPING_NO_ATTEMPT+]
 		#   connection not attempted (bad params)
 		#
-		# See also check_connection for a way to check the connection without doing any server communication.
+		# See also check_socket for a way to check the connection without doing any server communication.
 		def ping(*args)
 			if Fiber.respond_to?(:scheduler) && Fiber.scheduler
 				# Run PQping in a second thread to avoid blocking of the scheduler.

spec/pg/connection_spec.rb

@@ -1678,15 +1678,15 @@
 		expect{ conn.consume_input }.to raise_error(PG::ConnectionBad, /can't get socket descriptor|connection not open/){|err| expect(err).to have_attributes(connection: conn) }
 	end
 
-	describe :check_connection do
+	describe :check_socket do
 		it "does nothing if connection is OK" do
-			expect( @conn.check_connection ).to be_nil
+			expect( @conn.check_socket ).to be_nil
 		end
 
-		def wait_check_connection(conn)
+		def wait_check_socket(conn)
 			retries = 100
 			loop do
-				conn.check_connection
+				conn.check_socket
 				sleep 0.1
 				break if (retries-=1) < 0
 			end
@@ -1698,7 +1698,7 @@ def wait_check_connection(conn)
 			expect( conn.get_result.result_status ).to be( PG::PGRES_FATAL_ERROR )
 
 			expect do
-				wait_check_connection(conn)
+				wait_check_socket(conn)
 			end.to raise_error(PG::ConnectionBad, /SSL connection has been closed unexpectedly|server closed the connection unexpectedly/)
 		end
 
@@ -1707,7 +1707,7 @@ def wait_check_connection(conn)
 			conn.send_query "do $$ BEGIN RAISE NOTICE 'foo'; PERFORM pg_terminate_backend(pg_backend_pid()); END; $$ LANGUAGE plpgsql;"
 
 			expect do
-				wait_check_connection(conn)
+				wait_check_socket(conn)
 			end.to raise_error(PG::ConnectionBad, /SSL connection has been closed unexpectedly|server closed the connection unexpectedly/)
 		end
 	end