concurrent-ruby 0.9.2-java → 1.0.0-java

data/lib/concurrent/scheduled_task.rb

@@ -1,12 +1,13 @@
+require 'concurrent/constants'
 require 'concurrent/errors'
+require 'concurrent/configuration'
 require 'concurrent/ivar'
 require 'concurrent/collection/copy_on_notify_observer_set'
-require 'concurrent/executor/executor'
 require 'concurrent/utility/monotonic_time'
-require 'concurrent/concern/deprecation'
 
 module Concurrent
-  include Concern::Deprecation
+
+  autoload :Options, 'concurrent/options'
 
   # `ScheduledTask` is a close relative of `Concurrent::Future` but with one
   # important difference: A `Future` is set to execute as soon as possible
@@ -161,24 +162,20 @@ module Concurrent
     #
     # @raise [ArgumentError] When no block is given
     # @raise [ArgumentError] When given a time that is in the past
-    #
-    # @!macro [attach] deprecated_scheduling_by_clock_time
-    #
-    #   @note Scheduling is now based on a monotonic clock. This makes the timer much
-    #     more accurate, but only when scheduling based on a delay interval.
-    #     Scheduling a task based on a clock time is deprecated. It will still work
-    #     but will not be supported in the 1.0 release.
     def initialize(delay, opts = {}, &task)
       raise ArgumentError.new('no block given') unless block_given?
-      super(IVar::NO_VALUE, opts, &nil)
+      raise ArgumentError.new('seconds must be greater than zero') if delay.to_f < 0.0
+
+      super(NULL, opts, &nil)
+
       synchronize do
-        @delay = calculate_delay!(delay) # may raise exception
         ns_set_state(:unscheduled)
         @parent = opts.fetch(:timer_set, Concurrent.global_timer_set)
         @args = get_arguments_from(opts)
+        @delay = delay.to_f
         @task = task
         @time = nil
-        @executor = Executor.executor_from_options(opts) || Concurrent.global_io_executor
+        @executor = Options.executor_from_options(opts) || Concurrent.global_io_executor
         self.observers = Collection::CopyOnNotifyObserverSet.new
       end
     end
@@ -190,16 +187,6 @@ module Concurrent
       synchronize { @delay }
     end
 
-    # The `delay` value given at instanciation.
-    #
-    # @return [Float] the initial delay.
-    #
-    # @deprecated use {#initial_delay} instead
-    def delay
-      deprecated_method 'delay', 'initial_delay'
-      initial_delay
-    end
-
     # The monotonic time at which the the task is scheduled to be executed.
     #
     # @return [Float] the schedule time or nil if `unscheduled`
@@ -228,16 +215,6 @@ module Concurrent
       synchronize { ns_check_state?(:processing) }
     end
 
-    # In the task execution in progress?
-    #
-    # @return [Boolean] true if the task is in the given state else false
-    #
-    # @deprecated Use {#processing?} instead.
-    def in_progress?
-      deprecated_method 'in_progress?', 'processing?'
-      processing?
-    end
-
     # Cancel this task and prevent it from executing. A task can only be
     # cancelled if it is pending or unscheduled.
     #
@@ -253,17 +230,6 @@ module Concurrent
       end
     end
 
-    # Cancel this task and prevent it from executing. A task can only be
-    # cancelled if it is `:pending` or `:unscheduled`.
-    #
-    # @return [Boolean] true if successfully cancelled else false
-    #
-    # @deprecated Use {#cancel} instead.
-    def stop
-      deprecated_method 'stop', 'cancel'
-      cancel
-    end
-
     # Reschedule the task using the original delay and the current time.
     # A task can only be reset while it is `:pending`.
     #
@@ -281,7 +247,9 @@ module Concurrent
     #
     # @raise [ArgumentError] When given a time that is in the past
     def reschedule(delay)
-      synchronize{ ns_reschedule(calculate_delay!(delay)) }
+      delay = delay.to_f
+      raise ArgumentError.new('seconds must be greater than zero') if delay < 0.0
+      synchronize{ ns_reschedule(delay) }
     end
 
     # Execute an `:unscheduled` `ScheduledTask`. Immediately sets the state to `:pending`
@@ -306,8 +274,6 @@ module Concurrent
     # @return [ScheduledTask] the newly created `ScheduledTask` in the `:pending` state
     #
     # @raise [ArgumentError] if no block is given
-    #
-    # @!macro deprecated_scheduling_by_clock_time
     def self.execute(delay, opts = {}, &task)
       new(delay, opts, &task).execute
     end
@@ -348,29 +314,5 @@ module Concurrent
       return false unless ns_check_state?(:pending)
       @parent.send(:remove_task, self) && ns_schedule(delay)
     end
-
-    # Calculate the actual delay in seconds based on the given delay.
-    #
-    # @param [Float] delay the number of seconds to wait for before executing the task
-    #
-    # @return [Float] the number of seconds to delay
-    #
-    # @raise [ArgumentError] if the intended execution time is not in the future
-    # @raise [ArgumentError] if no block is given
-    #
-    # @!macro deprecated_scheduling_by_clock_time
-    #
-    # @!visibility private
-    def calculate_delay!(delay)
-      if delay.is_a?(Time)
-        deprecated 'Use an interval not a clock time; schedule is now based on a monotonic clock'
-        now = Time.now
-        raise ArgumentError.new('schedule time must be in the future') if delay <= now
-        delay.to_f - now.to_f
-      else
-        raise ArgumentError.new('seconds must be greater than zero') if delay.to_f < 0.0
-        delay.to_f
-      end
-    end
   end
 end

data/lib/concurrent/settable_struct.rb

@@ -74,8 +74,9 @@ module Concurrent
     # @raise [Concurrent::ImmutabilityError] if the given member has already been set
     def []=(member, value)
       if member.is_a? Integer
-        if member >= @values.length
-          raise IndexError.new("offset #{member} too large for struct(size:#{@values.length})")
+        length = synchronize { @values.length }
+        if member >= length
+          raise IndexError.new("offset #{member} too large for struct(size:#{length})")
         end
         synchronize do
           unless @values[member].nil?
@@ -101,10 +102,10 @@ module Concurrent
       FACTORY.define_struct(clazz_name, args, &block)
     end
 
-    FACTORY = Class.new(Synchronization::Object) do
+    FACTORY = Class.new(Synchronization::LockableObject) do
       def define_struct(name, members, &block)
         synchronize do
-          clazz = Synchronization::AbstractStruct.define_struct_class(SettableStruct, Synchronization::Object, name, members, &block)
+          clazz = Synchronization::AbstractStruct.define_struct_class(SettableStruct, Synchronization::LockableObject, name, members, &block)
           members.each_with_index do |member, index|
             clazz.send(:define_method, member) do
               synchronize { @values[index] }

data/lib/concurrent/synchronization.rb

@@ -1,16 +1,28 @@
 require 'concurrent/utility/engine'
+
 require 'concurrent/synchronization/abstract_object'
-require 'concurrent/synchronization/java_object'
-require 'concurrent/synchronization/mutex_object'
-require 'concurrent/synchronization/monitor_object'
+require 'concurrent/utility/native_extension_loader' # load native parts first
+Concurrent.load_native_extensions
+
+require 'concurrent/synchronization/mri_object'
+require 'concurrent/synchronization/jruby_object'
 require 'concurrent/synchronization/rbx_object'
 require 'concurrent/synchronization/object'
+require 'concurrent/synchronization/volatile'
+
+require 'concurrent/synchronization/abstract_lockable_object'
+require 'concurrent/synchronization/mri_lockable_object'
+require 'concurrent/synchronization/jruby_lockable_object'
+require 'concurrent/synchronization/rbx_lockable_object'
+
+require 'concurrent/synchronization/lockable_object'
 
 require 'concurrent/synchronization/condition'
 require 'concurrent/synchronization/lock'
 
 module Concurrent
   # {include:file:doc/synchronization.md}
+  # {include:file:doc/synchronization-notes.md}
   module Synchronization
   end
 end

data/lib/concurrent/synchronization/abstract_lockable_object.rb

@@ -0,0 +1,98 @@
+module Concurrent
+  module Synchronization
+
+    # @!visibility private
+    class AbstractLockableObject < Object
+
+      protected
+
+      # @!macro [attach] synchronization_object_method_synchronize
+      #
+      #   @yield runs the block synchronized against this object,
+      #     equivalent of java's `synchronize(this) {}`
+      #   @note can by made public in descendants if required by `public :synchronize`
+      def synchronize
+        raise NotImplementedError
+      end
+
+      # @!macro [attach] synchronization_object_method_ns_wait_until
+      #
+      #   Wait until condition is met or timeout passes,
+      #   protects against spurious wake-ups.
+      #   @param [Numeric, nil] timeout in seconds, `nil` means no timeout
+      #   @yield condition to be met
+      #   @yieldreturn [true, false]
+      #   @return [true, false] if condition met
+      #   @note only to be used inside synchronized block
+      #   @note to provide direct access to this method in a descendant add method
+      #     ```
+      #     def wait_until(timeout = nil, &condition)
+      #       synchronize { ns_wait_until(timeout, &condition) }
+      #     end
+      #     ```
+      def ns_wait_until(timeout = nil, &condition)
+        if timeout
+          wait_until = Concurrent.monotonic_time + timeout
+          loop do
+            now              = Concurrent.monotonic_time
+            condition_result = condition.call
+            return condition_result if now >= wait_until || condition_result
+            ns_wait wait_until - now
+          end
+        else
+          ns_wait timeout until condition.call
+          true
+        end
+      end
+
+      # @!macro [attach] synchronization_object_method_ns_wait
+      #
+      #   Wait until another thread calls #signal or #broadcast,
+      #   spurious wake-ups can happen.
+      #
+      #   @param [Numeric, nil] timeout in seconds, `nil` means no timeout
+      #   @return [self]
+      #   @note only to be used inside synchronized block
+      #   @note to provide direct access to this method in a descendant add method
+      #     ```
+      #     def wait(timeout = nil)
+      #       synchronize { ns_wait(timeout) }
+      #     end
+      #     ```
+      def ns_wait(timeout = nil)
+        raise NotImplementedError
+      end
+
+      # @!macro [attach] synchronization_object_method_ns_signal
+      #
+      #   Signal one waiting thread.
+      #   @return [self]
+      #   @note only to be used inside synchronized block
+      #   @note to provide direct access to this method in a descendant add method
+      #     ```
+      #     def signal
+      #       synchronize { ns_signal }
+      #     end
+      #     ```
+      def ns_signal
+        raise NotImplementedError
+      end
+
+      # @!macro [attach] synchronization_object_method_ns_broadcast
+      #
+      #   Broadcast to all waiting threads.
+      #   @return [self]
+      #   @note only to be used inside synchronized block
+      #   @note to provide direct access to this method in a descendant add method
+      #     ```
+      #     def broadcast
+      #       synchronize { ns_broadcast }
+      #     end
+      #     ```
+      def ns_broadcast
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/concurrent/synchronization/abstract_object.rb

@@ -1,162 +1,23 @@
 module Concurrent
   module Synchronization
 
-    # @!macro synchronization_object
     # @!visibility private
+    # @!macro internal_implementation_note
     class AbstractObject
 
-      # @!macro [attach] synchronization_object_method_initialize
-      #  
-      #   @abstract for helper ivar initialization if needed,
-      #     otherwise it can be left empty. It has to call ns_initialize.
-      def initialize(*args, &block)
+      # @abstract has to be implemented based on Ruby runtime
+      def initialize
         raise NotImplementedError
       end
 
-      protected
-
-      # @!macro [attach] synchronization_object_method_synchronize
-      #  
-      #   @yield runs the block synchronized against this object,
-      #     equivalent of java's `synchronize(this) {}`
-      #   @note can by made public in descendants if required by `public :synchronize`
-      def synchronize
-        raise NotImplementedError
-      end
-
-      # @!macro [attach] synchronization_object_method_ns_initialize
-      #  
-      #   initialization of the object called inside synchronize block
-      #   @note has to be called manually when required in children of this class
-      #   @example
-      #     class Child < Concurrent::Synchornization::Object
-      #       def initialize(*args, &block)
-      #         super(&nil)
-      #         synchronize { ns_initialize(*args, &block) }
-      #       end
-      #     
-      #       def ns_initialize(*args, &block)
-      #         @args = args          
-      #       end
-      #     end
-      def ns_initialize(*args, &block)
-      end
-
-      # @!macro [attach] synchronization_object_method_ns_wait_until
-      #  
-      #   Wait until condition is met or timeout passes,
-      #   protects against spurious wake-ups.
-      #   @param [Numeric, nil] timeout in seconds, `nil` means no timeout
-      #   @yield condition to be met
-      #   @yieldreturn [true, false]
-      #   @return [true, false] if condition met
-      #   @note only to be used inside synchronized block
-      #   @note to provide direct access to this method in a descendant add method
-      #     ```
-      #     def wait_until(timeout = nil, &condition)
-      #       synchronize { ns_wait_until(timeout, &condition) }
-      #     end
-      #     ```
-      def ns_wait_until(timeout = nil, &condition)
-        if timeout
-          wait_until = Concurrent.monotonic_time + timeout
-          loop do
-            now              = Concurrent.monotonic_time
-            condition_result = condition.call
-            # 0.001 correction to avoid error when `wait_until - now` is smaller than 0.0005 and rounded to 0
-            # when passed to java #wait(long timeout)
-            return condition_result if (now + 0.001) >= wait_until || condition_result
-            ns_wait wait_until - now
-          end
-        else
-          ns_wait timeout until condition.call
-          true
-        end
-      end
-
-      # @!macro [attach] synchronization_object_method_ns_wait
-      #  
-      #   Wait until another thread calls #signal or #broadcast,
-      #   spurious wake-ups can happen.
-      #  
-      #   @param [Numeric, nil] timeout in seconds, `nil` means no timeout
-      #   @return [self]
-      #   @note only to be used inside synchronized block
-      #   @note to provide direct access to this method in a descendant add method
-      #     ```
-      #     def wait(timeout = nil)
-      #       synchronize { ns_wait(timeout) }
-      #     end
-      #     ```
-      def ns_wait(timeout = nil)
+      # @!visibility private
+      # @abstract
+      def full_memory_barrier
         raise NotImplementedError
       end
 
-      # @!macro [attach] synchronization_object_method_ns_signal
-      #    
-      #   Signal one waiting thread.
-      #   @return [self]
-      #   @note only to be used inside synchronized block
-      #   @note to provide direct access to this method in a descendant add method
-      #     ```
-      #     def signal
-      #       synchronize { ns_signal }
-      #     end
-      #     ```
-      def ns_signal
-        raise NotImplementedError
-      end
-
-      # @!macro [attach] synchronization_object_method_ns_broadcast
-      #  
-      #   Broadcast to all waiting threads.
-      #   @return [self]
-      #   @note only to be used inside synchronized block
-      #   @note to provide direct access to this method in a descendant add method
-      #     ```
-      #     def broadcast
-      #       synchronize { ns_broadcast }
-      #     end
-      #     ```
-      def ns_broadcast
-        raise NotImplementedError
-      end
-
-      # @!macro [attach] synchronization_object_method_ensure_ivar_visibility
-      #  
-      #   Allows to construct immutable objects where all fields are visible after initialization, not requiring
-      #   further synchronization on access.
-      #   @example
-      #     class AClass
-      #       attr_reader :val
-      #       def initialize(val)
-      #         @val = val # final value, after assignment it's not changed (just convention, not enforced)
-      #         ensure_ivar_visibility!
-      #         # now it can be shared as Java's final field
-      #       end
-      #     end
-      def ensure_ivar_visibility!
-        raise NotImplementedError
-      end
-
-      # @!macro [attach] synchronization_object_method_self_attr_volatile
-      #    
-      #   creates methods for reading and writing to a instance variable with volatile (Java semantic) instance variable
-      #   return [Array<Symbol>] names of defined method names
       def self.attr_volatile(*names)
-        names.each do |name|
-          ivar = :"@volatile_#{name}"
-          class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def #{name}
-              #{ivar}
-            end
-
-            def #{name}=(value)
-              #{ivar} = value
-            end
-          RUBY
-        end
-        names.map { |n| [n, :"#{n}="] }.flatten
+        raise NotImplementedError
       end
     end
   end