@@ -19,36 +19,36 @@ module Concurrent
1919 #
2020 # An independent, concurrent, single-purpose, computational entity that communicates exclusively via message passing.
2121 #
22- # The ` Concurrent::Actor` class in this library is based solely on the
22+ # The + Concurrent::Actor+ class in this library is based solely on the
2323 # {http://www.scala-lang.org/api/current/index.html#scala.actors.Actor Actor} trait
2424 # defined in the Scala standard library. It does not implement all the features of
25- # Scala's ` Actor` but its behavior for what *has* been implemented is nearly identical.
25+ # Scala's + Actor+ but its behavior for what *has* been implemented is nearly identical.
2626 # The excluded features mostly deal with Scala's message semantics, strong typing,
2727 # and other characteristics of Scala that don't really apply to Ruby.
2828 #
29- # Unlike most of the abstractions in this library, ` Actor` takes an *object-oriented*
29+ # Unlike many of the abstractions in this library, + Actor+ takes an *object-oriented*
3030 # approach to asynchronous concurrency, rather than a *functional programming*
3131 # approach.
3232 #
33- # Because ` Actor` mixes in the ` Concurrent::Runnable` module subclasses have access to
34- # the ` #on_error` method and can override it to implement custom error handling. The
35- # ` Actor` base class does not use ` #on_error` so as to avoid conflit with subclasses
36- # which override it. Generally speaking, ` #on_error` should not be used. The ` Actor`
33+ # Because + Actor+ mixes in the + Concurrent::Runnable+ module subclasses have access to
34+ # the + #on_error+ method and can override it to implement custom error handling. The
35+ # + Actor+ base class does not use + #on_error+ so as to avoid conflit with subclasses
36+ # which override it. Generally speaking, + #on_error+ should not be used. The + Actor+
3737 # base class provides concictent, reliable, and robust error handling already, and
3838 # error handling specifics are tied to the message posting method. Incorrect behavior
39- # in an ` #on_error` override can lead to inconsistent ` Actor` behavior that may lead
39+ # in an + #on_error+ override can lead to inconsistent + Actor+ behavior that may lead
4040 # to confusion and difficult debugging.
4141 #
42- # The ` Actor` superclass mixes in the Ruby standard library
42+ # The + Actor+ superclass mixes in the Ruby standard library
4343 # {http://ruby-doc.org/stdlib-2.0/libdoc/observer/rdoc/Observable.html Observable}
4444 # module to provide consistent callbacks upon message processing completion. The normal
45- # ` Observable` methods, including ` #add_observer` behave normally. Once an observer
46- # is added to an ` Actor` it will be notified of all messages processed *after*
45+ # + Observable+ methods, including + #add_observer+ behave normally. Once an observer
46+ # is added to an + Actor+ it will be notified of all messages processed *after*
4747 # addition. Notification will *not* occur for any messages that have already been
4848 # processed.
4949 #
5050 # Observers will be notified regardless of whether the message processing is successful
51- # or not. The ` #update` method of the observer will receive four arguments. The
51+ # or not. The + #update+ method of the observer will receive four arguments. The
5252 # appropriate method signature is:
5353 #
5454 # def update(time, message, result, reason)
@@ -57,8 +57,8 @@ module Concurrent
5757 #
5858 # * The time that message processing was completed
5959 # * An array containing all elements of the original message, in order
60- # * The result of the call to ` #act` (will be ` nil` if an exception was raised)
61- # * Any exception raised by ` #act` (or ` nil` if message processing was successful)
60+ # * The result of the call to + #act+ (will be + nil+ if an exception was raised)
61+ # * Any exception raised by + #act+ (or + nil+ if message processing was successful)
6262 #
6363 # @example Actor Ping Pong
6464 # class Ping < Concurrent::Actor
@@ -140,10 +140,10 @@ def initialize(queue)
140140
141141 # Create a pool of actors that share a common mailbox.
142142 #
143- # Every ` Actor` instance operates on its own thread. When one thread isn't enough capacity
144- # to manage all the messages being sent to an ` Actor` a *pool* can be used instead. A pool
145- # is a collection of ` Actor` instances, all of the same type, that shate a message queue.
146- # Messages from other threads are all sent to a single queue against which all ` Actor` s
143+ # Every + Actor+ instance operates on its own thread. When one thread isn't enough capacity
144+ # to manage all the messages being sent to an + Actor+ a *pool* can be used instead. A pool
145+ # is a collection of + Actor+ instances, all of the same type, that shate a message queue.
146+ # Messages from other threads are all sent to a single queue against which all + Actor+ s
147147 # load balance.
148148 #
149149 # @param [Integer] count the number of actors in the pool
@@ -152,7 +152,7 @@ def initialize(queue)
152152 # @return [Array] two-element array with the shared mailbox as the first element
153153 # and an array of actors as the second element
154154 #
155- # @raise ArgumentError if ` count` is zero or less
155+ # @raise ArgumentError if + count+ is zero or less
156156 #
157157 # @example
158158 # class EchoActor < Concurrent::Actor
@@ -191,35 +191,35 @@ def self.pool(count, *args, &block)
191191
192192 protected
193193
194- # Actors are defined by subclassing the ` Concurrent::Actor` class and overriding the
195- # #act method. The #act method can have any signature/arity but ` def act(*args)`
194+ # Actors are defined by subclassing the + Concurrent::Actor+ class and overriding the
195+ # #act method. The #act method can have any signature/arity but + def act(*args)+
196196 # is the most flexible and least error-prone signature. The #act method is called in
197- # response to a message being post to the ` Actor` instance (see *Behavior* below).
197+ # response to a message being post to the + Actor+ instance (see *Behavior* below).
198198 #
199199 # @param [Array] message one or more arguments representing the message sent to the
200200 # actor via one of the Concurrent::Postable methods
201201 #
202202 # @return [Object] the result obtained when the message is successfully processed
203203 #
204- # @raise NotImplementedError unless overridden in the ` Actor` subclass
204+ # @raise NotImplementedError unless overridden in the + Actor+ subclass
205205 #
206206 # @!visibility public
207207 def act ( *message )
208208 raise NotImplementedError . new ( "#{ self . class } )
209209 end
210210
211- # @private
211+ # @!visibility private
212212 def on_run # :nodoc:
213213 queue . clear
214214 end
215215
216- # @private
216+ # @!visibility private
217217 def on_stop # :nodoc:
218218 queue . clear
219219 queue . push ( :stop )
220220 end
221221
222- # @private
222+ # @!visibility private
223223 def on_task # :nodoc:
224224 package = queue . pop
225225 return if package == :stop
@@ -235,8 +235,8 @@ def on_task # :nodoc:
235235 if notifier . is_a? ( Event ) && ! notifier . set?
236236 package . handler . push ( result || ex )
237237 package . notifier . set
238- elsif package . handler . is_a? ( Contract )
239- package . handler . complete ( result , ex )
238+ elsif package . handler . is_a? ( IVar )
239+ package . handler . complete ( ! result . nil? , result , ex )
240240 elsif package . handler . respond_to? ( :post ) && ex . nil?
241241 package . handler . post ( result )
242242 end
@@ -246,7 +246,7 @@ def on_task # :nodoc:
246246 end
247247 end
248248
249- # @private
249+ # @!visibility private
250250 def on_error ( time , msg , ex ) # :nodoc:
251251 end
252252 end
0 commit comments