"Fossies" - the Fresh Open Source Software Archive

Member "selenium-selenium-4.8.1/rb/lib/selenium/webdriver/common/socket_lock.rb" (17 Feb 2023, 2112 Bytes) of package /linux/www/selenium-selenium-4.8.1.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Ruby source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "socket_lock.rb": 4.7.0_vs_4.8.0.

    1 # frozen_string_literal: true
    2 
    3 # Licensed to the Software Freedom Conservancy (SFC) under one
    4 # or more contributor license agreements.  See the NOTICE file
    5 # distributed with this work for additional information
    6 # regarding copyright ownership.  The SFC licenses this file
    7 # to you under the Apache License, Version 2.0 (the
    8 # "License"); you may not use this file except in compliance
    9 # with the License.  You may obtain a copy of the License at
   10 #
   11 #   http://www.apache.org/licenses/LICENSE-2.0
   12 #
   13 # Unless required by applicable law or agreed to in writing,
   14 # software distributed under the License is distributed on an
   15 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   16 # KIND, either express or implied.  See the License for the
   17 # specific language governing permissions and limitations
   18 # under the License.
   19 
   20 module Selenium
   21   module WebDriver
   22     #
   23     # @api private
   24     #
   25 
   26     class SocketLock
   27       def initialize(port, timeout)
   28         @port    = port
   29         @server  = nil
   30         @timeout = timeout
   31       end
   32 
   33       #
   34       # Attempt to acquire a lock on the given port. Control is yielded to an
   35       # execution block if the lock could be successfully obtained.
   36       #
   37 
   38       def locked
   39         lock
   40 
   41         begin
   42           yield
   43         ensure
   44           release
   45         end
   46       end
   47 
   48       private
   49 
   50       def lock
   51         max_time = current_time + @timeout
   52 
   53         sleep 0.1 until can_lock? || current_time >= max_time
   54 
   55         return if did_lock?
   56 
   57         raise Error::WebDriverError, "unable to bind to locking port #{@port} within #{@timeout} seconds"
   58       end
   59 
   60       def current_time
   61         Process.clock_gettime(Process::CLOCK_MONOTONIC)
   62       end
   63 
   64       def release
   65         @server&.close
   66       end
   67 
   68       def can_lock?
   69         @server = TCPServer.new(Platform.localhost, @port)
   70         @server.close_on_exec = true
   71         true
   72       rescue SocketError, Errno::EADDRINUSE, Errno::EBADF => e
   73         WebDriver.logger.debug("#{self}: #{e.message}")
   74         false
   75       end
   76 
   77       def did_lock?
   78         !@server.nil?
   79       end
   80     end # SocketLock
   81   end # WebDriver
   82 end # Selenium