event_bus 0.4.1

Event Bus

A simple Event Bus using Dart Streams for decoupling applications.

Star this Repo Pub Package Build Status

GitHub | Pub | Demos and Examples

Event Bus Pattern

An Event Bus follows the publish/subscribe pattern. It allows listeners to subscribe for events and publishers to fire events. This enables objects to interact without requiring to explicitly define listeners and keeping track of them.

Event Bus and MVC

The Event Bus pattern is especially helpful for decoupling MVC (or MVP) applications.

One group of MVC is not a problem.

Model-View-Controller

But as soon as there are multiple groups of MVCs, those groups will have to talk to each other. This creates a tight coupling between the controllers.

Multi Model-View-Controllers

By communication through an Event Bus, the coupling is reduced.

Event Bus

Usage

1. Create an Event Bus

Create an instance of EventBus and make it available to other classes.

Usually there is just one Event Bus per application, but more than one may be set up to group a specific set of events.

import 'package:event_bus/event_bus.dart';

EventBus eventBus = new EventBus();

You can alternatively use the HierarchicalEventBus that filters events by event class including its subclasses.

Note that the hierarchical event bus uses dart:mirrors which support in dart2js is experimental.

import 'package:event_bus/event_bus_hierarchical.dart';

EventBus eventBus = new HierarchicalEventBus();

Note: The default constructor will create an asynchronous event bus. To create a synchronous you must provide the optional sync: true attribute.

2. Define Events

Any Dart class can be used as an event.

class UserLoggedInEvent {
  User user;
  
  UserLoggedInEvent(this.user);
}

class NewOrderEvent {
  Order order;
  
  NewOrderEvent(this.order);
}

3. Register Listeners

Register listeners for a specific events:

eventBus.on(UserLoggedInEvent).listen((UserLoggedInEvent event) {
  print(event.user);
});

Register listeners for all events:

eventBus.on().listen((event) {
  // Print the runtime type. Such a set up could be used for logging.
  print(event.runtimeType); 
});

About Dart Streams

EventBus uses Dart Streams as its underlying mechanism to keep track of listeners. You may use all functionality available by the Stream API. One example is the use of StreamSubscriptions to later unsubscribe from the events.

StreamSubscription loginSubscription = eventBus.on(UserLoggedInEvent).listen((UserLoggedInEvent event) {
  print(event.user);	
});

loginSubscription.cancel();

4. Fire Events

Finally, we need to fire an event.

User myUser = new User('Mickey');
eventBus.fire(new UserLoggedInEvent(myUser));

License

The MIT License (MIT)

Changelog

Version 0.4.1 (2015-05-13)

  • Fix Issue #13: Improve on() stream when no type is specified

Version 0.4.0 (2015-05-03)

  • BREAKING CHANGE: Moved the HierarchicalEventBus to a separate library to be able to remove dart:mirrors from the normal EventBus.
    Users of the hierarchical event bus must import event_bus_hierarchical.dart and replace the use of the factory constructor EventBus.hierarchical() with the HierarchicalEventBus constructor.

Version 0.3.0 (2014-09-08)

  • BREAKING CHANGE: Changed and simplified the EventBus API. We can now dispatch any Dart object as an event. Before, we had to create an EventType for every type of event we wanted to fire. Now we can use any class as an event. Listeners can (optionally) filter events by that class.
  • Added a way to create a hierarchical event bus that filters events by class and their subclasses. This currently only works with classes extending other classes and not with implementing an interface. We might have to wait for https://code.google.com/p/dart/issues/detail?id=20756 to enable interfaces.
  • BREAKING CHANGE: The EventBus constructor defaults to async instead of sync!!. This matches the constructor of the Dart Streams and an async event bus might also be the more common use case.
  • BREAKING CHANGE: Removed LoggingEventBus. Reason is that logging can easily be implemented with a event listener that listens for all events and logs them.

Version 0.2.5 (2014-09-03)

  • Update example.
  • Update readme with new links.
  • Update dependencies.

Version 0.2.4 (2013-11-11)

  • Update to dart libraries 0.9.0.

Version 0.2.3 (2013-09-16)

  • Fix issue #8: Add logging of events that flow through event bus

Version 0.2.2 (2013-09-16)

  • Change default of SimpleEventBus to sync (same as factory in EventBus)

Version 0.2.1 (2013-07-01)

  • Fix issue #6: Fire should accept null as data

Version 0.2.0 (2013-06-06)

  • Update to new Dart SDK v0.5.13.1_r23552.
  • Using Darts new Stream.broadcast() factory.
  • Provide option for synchronous broadcasting of events.
  • Update unit tests and example.
  • Create demo page.

Version 0.1.3 (2013-05-19)

  • Removed all occurrences of @override

Version 0.1.2 (2013-05-17)

  • Change in README: contained wrong license (Apache instead of MIT).
  • Remove import 'package:meta/meta.dart' in event_bus.dart as it is not needed and may cause an error if used as pub package.

Version 0.1.1 (2013-04-29)

  • Minor change in README to fix image links.

Version 0.1.0 (2013-04-29)

  • Initial Version.

1. Depend on it

Add this to your package's pubspec.yaml file:

dependencies:
  event_bus: 

2. Install it

You can install packages from the command line:

$ pub get

Alternatively, your editor might support pub. Check the docs for your editor to learn more.

About

A simple Event Bus using Dart Streams for decoupling applications

Author

Email majakob@gmx.ch Marco Jakob

Homepage

code.makery.ch/library/dart-event-bus

Documentation

www.dartdocs.org/documentation/event_bus/0.4.1/

Source code (hyperlinked)

www.crossdart.info/p/event_bus/0.4.1/

Uploader

marco.jkob@gmail.com

Share