require 'timers' module Celluloid # Don't do Actor-like things outside Actor scope class NotActorError < StandardError; end # Trying to do something to a dead actor class DeadActorError < StandardError; end # A timeout occured before the given request could complete class TimeoutError < StandardError; end # The caller made an error, not the current actor class AbortError < StandardError attr_reader :cause def initialize(cause) @cause = cause super "caused by #{cause.inspect}: #{cause.to_s}" end end LINKING_TIMEOUT = 5 # linking times out after 5 seconds # Actors are Celluloid's concurrency primitive. They're implemented as # normal Ruby objects wrapped in threads which communicate with asynchronous # messages. class Actor attr_reader :subject, :proxy, :tasks, :links, :mailbox, :thread, :name class << self extend Forwardable def_delegators "Celluloid::Registry.root", :[], :[]= def registered Registry.root.names end def clear_registry Registry.root.clear end # Obtain the current actor def current actor = Thread.current[:actor] raise NotActorError, "not in actor scope" unless actor actor.proxy end # Obtain the name of the current actor def name actor = Thread.current[:actor] raise NotActorError, "not in actor scope" unless actor actor.name end # Invoke a method on the given actor via its mailbox def call(mailbox, meth, *args, &block) call = SyncCall.new(Thread.mailbox, meth, args, block) begin mailbox << call rescue MailboxError raise DeadActorError, "attempted to call a dead actor" end if Celluloid.actor? and not Celluloid.exclusive? # The current task will be automatically resumed when we get a response Task.suspend(:callwait).value else # Otherwise we're inside a normal thread or exclusive, so block response = loop do message = Thread.mailbox.receive do |msg| msg.respond_to?(:call) and msg.call == call end break message unless message.is_a?(SystemEvent) Thread.current[:actor].handle_system_event(message) end response.value end end # Invoke a method asynchronously on an actor via its mailbox def async(mailbox, meth, *args, &block) begin mailbox << AsyncCall.new(meth, args, block) rescue MailboxError # Silently swallow asynchronous calls to dead actors. There's no way # to reliably generate DeadActorErrors for async calls, so users of # async calls should find other ways to deal with actors dying # during an async call (i.e. linking/supervisors) end end # Call a method asynchronously and retrieve its value later def future(mailbox, meth, *args, &block) future = Future.new future.execute(mailbox, meth, args, block) future end # Obtain all running actors in the system def all actors = [] Thread.list.each do |t| actor = t[:actor] actors << actor.proxy if actor and actor.respond_to?(:proxy) end actors end # Watch for exit events from another actor def monitor(actor) raise NotActorError, "can't link outside actor context" unless Celluloid.actor? Thread.current[:actor].linking_request(actor, :link) end # Stop waiting for exit events from another actor def unmonitor(actor) raise NotActorError, "can't link outside actor context" unless Celluloid.actor? Thread.current[:actor].linking_request(actor, :unlink) end # Link to another actor def link(actor) monitor actor Thread.current[:actor].links << actor end # Unlink from another actor def unlink(actor) unmonitor actor Thread.current[:actor].links.delete actor end # Are we monitoring the given actor? def monitoring?(actor) actor.links.include? Actor.current end # Are we bidirectionally linked to the given actor? def linked_to?(actor) monitoring?(actor) && Thread.current[:actor].links.include?(actor) end # Forcibly kill a given actor def kill(actor) actor.thread.kill begin actor.mailbox.shutdown rescue DeadActorError end end # Wait for an actor to terminate def join(actor) actor.thread.join actor end end # Wrap the given subject with an Actor def initialize(subject, options = {}) @subject = subject @mailbox = options[:mailbox] || Mailbox.new @exit_handler = options[:exit_handler] @exclusives = options[:exclusive_methods] @task_class = options[:task_class] || Celluloid.task_class @tasks = Set.new @links = Links.new @signals = Signals.new @receivers = Receivers.new @timers = Timers.new @running = true @exclusive = false @name = nil @thread = ThreadHandle.new do Thread.current[:actor] = self Thread.current[:mailbox] = @mailbox run end @proxy = ActorProxy.new(self) end # Run the actor loop def run begin while @running if message = @mailbox.receive(timeout) handle_message message else # No message indicates a timeout @timers.fire @receivers.fire_timers end end rescue MailboxShutdown # If the mailbox detects shutdown, exit the actor end shutdown rescue Exception => ex handle_crash(ex) raise unless ex.is_a? StandardError end # Terminate this actor def terminate @running = false end # Is this actor running in exclusive mode? def exclusive? @exclusive end # Execute a code block in exclusive mode. def exclusive @exclusive = true yield ensure @exclusive = false end # Perform a linking request with another actor def linking_request(receiver, type) exclusive do start_time = Time.now receiver.mailbox << LinkingRequest.new(Actor.current, type) system_events = [] loop do wait_interval = start_time + LINKING_TIMEOUT - Time.now message = @mailbox.receive(wait_interval) do |msg| msg.is_a?(LinkingResponse) && msg.actor == receiver && msg.type == type end case message when LinkingResponse # We're done! system_events.each { |ev| handle_system_event(ev) } return when NilClass raise TimeoutError, "linking timeout of #{LINKING_TIMEOUT} seconds exceeded" when SystemEvent # Queue up pending system events to be processed after we've successfully linked system_events << message else raise 'wtf' end end end end # Send a signal with the given name to all waiting methods def signal(name, value = nil) @signals.send name, value end # Wait for the given signal def wait(name) @signals.wait name end # Receive an asynchronous message def receive(timeout = nil, &block) loop do message = @receivers.receive(timeout, &block) break message unless message.is_a?(SystemEvent) handle_system_event(message) end end # How long to wait until the next timer fires def timeout i1 = @timers.wait_interval i2 = @receivers.wait_interval if i1 and i2 i1 < i2 ? i1 : i2 elsif i1 i1 else i2 end end # Schedule a block to run at the given time def after(interval, &block) @timers.after(interval) { task(:timer, &block) } end # Schedule a block to run at the given time def every(interval, &block) @timers.every(interval) { task(:timer, &block) } end # Sleep for the given amount of time def sleep(interval) if Celluloid.exclusive? Kernel.sleep(interval) else task = Task.current @timers.after(interval) { task.resume } Task.suspend :sleeping end end # Handle standard low-priority messages def handle_message(message) case message when SystemEvent handle_system_event message when Call task(:message_handler, message.method) { message.dispatch(@subject) } when Response message.dispatch else @receivers.handle_message(message) end message end # Handle high-priority system event messages def handle_system_event(event) case event when ExitEvent task(:exit_handler, @exit_handler) { handle_exit_event event } when LinkingRequest event.process(links) when NamingRequest @name = event.name when TerminationRequest @running = false end end # Handle exit events received by this actor def handle_exit_event(event) # Run the exit handler if available return @subject.send(@exit_handler, event.actor, event.reason) if @exit_handler # Reraise exceptions from linked actors # If no reason is given, actor terminated cleanly raise event.reason if event.reason end # Handle any exceptions that occur within a running actor def handle_crash(exception) Logger.crash("#{@subject.class} crashed!", exception) shutdown ExitEvent.new(@proxy, exception) rescue => ex Logger.crash("#{@subject.class}: ERROR HANDLER CRASHED!", ex) end # Handle cleaning up this actor after it exits def shutdown(exit_event = ExitEvent.new(@proxy)) run_finalizer cleanup exit_event ensure Thread.current[:actor] = nil Thread.current[:mailbox] = nil end # Run the user-defined finalizer, if one is set def run_finalizer return unless @subject.respond_to? :finalize task(:finalizer, :finalize) { @subject.finalize } rescue => ex Logger.crash("#{@subject.class}#finalize crashed!", ex) end # Clean up after this actor def cleanup(exit_event) @mailbox.shutdown @links.send_event exit_event tasks.each { |task| task.terminate } rescue => ex Logger.crash("#{@subject.class}: CLEANUP CRASHED!", ex) end # Run a method inside a task unless it's exclusive def task(task_type, method_name = nil, &block) if @exclusives && (@exclusives == :all || @exclusives.include?(method_name)) exclusive { block.call } else @task_class.new(:message_handler, &block).resume end end end end