Sha256: 5a0a3b642330245e5f4e8dd619190da340009706b9cdfd3182dbc44159003dc2

Contents?: true

Size: 1.6 KB

Versions: 5

Compression:

Stored size: 1.6 KB

Contents

# encoding: ascii-8bit

# Copyright 2022 Ball Aerospace & Technologies Corp.
# All Rights Reserved.
#
# This program is free software; you can modify and/or redistribute it
# under the terms of the GNU Affero General Public License
# as published by the Free Software Foundation; version 3 with
# attribution addendums as found in the LICENSE.txt
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# This program may also be used under the terms of a commercial or
# enterprise edition license of COSMOS if purchased from the
# copyright holder

module Cosmos
  # Allows for a breakable sleep implementation using the self-pipe trick
  # See http://www.sitepoint.com/the-self-pipe-trick-explained/
  class Sleeper
    def initialize
      @pipe_reader, @pipe_writer = IO.pipe
      @readers = [@pipe_reader]
      @canceled = false
    end

    # Breakable version of sleep
    # @param seconds Number of seconds to sleep
    # @return true if the sleep was broken by someone calling cancel
    #   otherwise returns false
    def sleep(seconds)
      read_ready, _ = IO.select(@readers, nil, nil, seconds)
      if read_ready && read_ready.include?(@pipe_reader)
        return true
      else
        return false
      end
    end

    # Break sleeping - Once canceled a sleeper cannot be used again
    def cancel
      if !@canceled
        @canceled = true
        @pipe_writer.write('.')
      end
    end
  end
end # module Cosmos

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
cosmos-5.0.5 lib/cosmos/utilities/sleeper.rb
cosmos-5.0.4 lib/cosmos/utilities/sleeper.rb
cosmos-5.0.3 lib/cosmos/utilities/sleeper.rb
cosmos-5.0.2 lib/cosmos/utilities/sleeper.rb
cosmos-5.0.2.pre.beta2 lib/cosmos/utilities/sleeper.rb