event_bus 0.3.0+1

A simple Event Bus using Dart Streams for decoupling applications

Event Bus

A simple Event Bus using Dart Streams for decoupling applications.

Demo

See Dart Event Bus in action.

All examples are also available in the example directory on GitHub.

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.

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.

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

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.

EventBus eventBus = new EventBus.hierarchical();

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.text);
}

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)