module Athena::EventDispatcher::StoppableEvent

Overview

An AED::Event whose processing may be interrupted when the event has been handled.

AED::EventDispatcherInterface implementations MUST check to determine if an AED::Event is marked as stopped after each listener is called. If it is, then the dispatcher should return immediately without calling any further listeners.

class MyEvent < AED::Event; end

dispatcher = AED::EventDispatcher.new

dispatcher.listener(MyEvent) { pp "callback1" }
dispatcher.listener(MyEvent) { |e| pp "callback2"; e.stop_propagation }
dispatcher.listener(MyEvent) { pp "callback3" }

dispatcher.dispatch MyEvent.new
# =>
#   "callback1"
#   "callback2"

Direct including types

• Athena::EventDispatcher::Event

Defined in:

stoppable_event.cr

Instance Method Summary

• #propagate? : Bool

  If future listeners should be executed.

• #stop_propagation : Nil

  Prevent future listeners from executing once any listener calls #stop_propagation.

Instance Method Detail