Documentation and few updates and class conversions

Author: pitr-ch

doc/synchronization.md

@@ -111,9 +111,10 @@ class Atom < Synchronization::Object
     #
     # @raise [ArgumentError] if the validator is not a `Proc` (when given)
     def initialize(value, opts = {})
+      super()
       @Validator     = opts.fetch(:validator, -> v { true })
       self.observers = Collection::CopyOnNotifyObserverSet.new
-      super(value)
+      self.value     = value
     end
 
     # @!method value

lib/concurrent/atom.rb

@@ -15,7 +15,8 @@ class AtomicMarkableReference < ::Concurrent::Synchronization::Object
 
       # @!macro [attach] atomic_markable_reference_method_initialize
       def initialize(value = nil, mark = false)
-        super(ImmutableArray[value, mark]) # ensures visibility
+        super()
+        self.reference = ImmutableArray[value, mark]
       end
 
       # @!macro [attach] atomic_markable_reference_method_compare_and_set

lib/concurrent/edge/atomic_markable_reference.rb

@@ -131,6 +131,8 @@ def post_on(executor, *args, &job)
     # Represents an event which will happen in future (will be completed). It has to always happen.
     class Event < Synchronization::LockableObject
       safe_initialization!
+      private *attr_volatile_with_cas(:internal_state)
+      public :internal_state
       include Concern::Deprecation
 
       # @!visibility private
@@ -180,17 +182,17 @@ def initialize(promise, default_executor)
         # TODO (pitr 12-Sep-2015): replace with AtomicFixnum, avoid aba problem
         # TODO (pitr 12-Sep-2015): look at java.util.concurrent solution
         @Waiters         = LockFreeStack.new
-        @State           = AtomicReference.new PENDING
+        self.internal_state = PENDING
       end
 
       # @return [:pending, :completed]
       def state
-        @State.get.to_sym
+        internal_state.to_sym
       end
 
       # Is Event/Future pending?
       # @return [Boolean]
-      def pending?(state = @State.get)
+      def pending?(state = internal_state)
         !state.completed?
       end
 
@@ -202,7 +204,7 @@ def unscheduled?
 
       # Has the Event been completed?
       # @return [Boolean]
-      def completed?(state = @State.get)
+      def completed?(state = internal_state)
         state.completed?
       end
 
@@ -313,7 +315,7 @@ def set(*args, &block)
 
       # @!visibility private
       def complete_with(state, raise_on_reassign = true)
-        if @State.compare_and_set(PENDING, state)
+        if compare_and_set_internal_state(PENDING, state)
           #(state)
           # go to synchronized block only if there were waiting threads
           synchronize { ns_broadcast } if @Waiters.clear
@@ -369,11 +371,6 @@ def waiting_threads
         @Waiters.each.to_a
       end
 
-      # @!visibility private
-      def internal_state
-        @State.get
-      end
-
       private
 
       # @return [true, false]
@@ -536,7 +533,7 @@ def apply(block)
 
       # Has Future been success?
       # @return [Boolean]
-      def success?(state = @State.get)
+      def success?(state = internal_state)
         state.completed? && state.success?
       end
 
@@ -547,7 +544,7 @@ def fulfilled?
 
       # Has Future been failed?
       # @return [Boolean]
-      def failed?(state = @State.get)
+      def failed?(state = internal_state)
         state.completed? && !state.success?
       end
 
@@ -563,23 +560,23 @@ def rejected?
       # @!macro edge.periodical_wait
       def value(timeout = nil)
         touch
-        @State.get.value if wait_until_complete timeout
+        internal_state.value if wait_until_complete timeout
       end
 
       # @return [Exception, nil] the reason of the Future's failure
       # @!macro edge.timeout_nil
       # @!macro edge.periodical_wait
       def reason(timeout = nil)
         touch
-        @State.get.reason if wait_until_complete timeout
+        internal_state.reason if wait_until_complete timeout
       end
 
       # @return [Array(Boolean, Object, Exception), nil] triplet of success, value, reason
       # @!macro edge.timeout_nil
       # @!macro edge.periodical_wait
       def result(timeout = nil)
         touch
-        @State.get.result if wait_until_complete timeout
+        internal_state.result if wait_until_complete timeout
       end
 
       # Wait until Future is #complete?
@@ -601,14 +598,14 @@ def wait!(timeout = nil)
       # @!macro edge.periodical_wait
       def value!(timeout = nil)
         touch
-        @State.get.value if wait_until_complete! timeout
+        internal_state.value if wait_until_complete! timeout
       end
 
       # @example allows failed Future to be risen
       #   raise Concurrent.future.fail
       def exception(*args)
         raise 'obligation is not failed' unless failed?
-        reason = @State.get.reason
+        reason = internal_state.reason
         if reason.is_a?(::Array)
           reason.each { |e| log ERROR, 'Edge::Future', e }
           Concurrent::Error.new 'multiple exceptions, inspect log'
@@ -727,7 +724,7 @@ def on_failure!(&callback)
 
       # @!visibility private
       def complete_with(state, raise_on_reassign = true)
-        if @State.compare_and_set(PENDING, state)
+        if compare_and_set_internal_state(PENDING, state)
           @Waiters.clear
           synchronize { ns_broadcast }
           call_callbacks state
@@ -745,12 +742,12 @@ def complete_with(state, raise_on_reassign = true)
 
       # @!visibility private
       def add_callback(method, *args)
-        state = @State.get
+        state = internal_state
         if completed?(state)
           call_callback method, state, *args
         else
           @Callbacks.push [method, *args]
-          state = @State.get
+          state = internal_state
           # take back if it was completed in the meanwhile
           call_callbacks state if completed?(state)
         end
@@ -759,7 +756,7 @@ def add_callback(method, *args)
 
       # @!visibility private
       def apply(block)
-        @State.get.apply block
+        internal_state.apply block
       end
 
       private

lib/concurrent/edge/future.rb

@@ -26,7 +26,8 @@ def next_node
       private *attr_volatile_with_cas(:head)
 
       def initialize
-        super(EMPTY)
+        super()
+        self.head = EMPTY
       end
 
       def empty?