better event emitter example

mojolicious · Oct 10, 2011 · dc99804 · dc99804
1 parent 8e686e5
commit dc99804
Showing 1 changed file with 12 additions and 11 deletions.
diff --git a/lib/Mojo/EventEmitter.pm b/lib/Mojo/EventEmitter.pm
@@ -94,27 +94,28 @@ __END__
 
 =head1 NAME
 
-Mojo::EventEmitter - IOLoop event emitter
+Mojo::EventEmitter - Event emitter base class
 
 =head1 SYNOPSIS
 
-  use Mojo::EventEmitter;
+  # Subclass
+  package Cat;
+  use Mojo::Base 'Mojo::EventEmitter';
 
-  # Create new event emitter
-  my $e = Mojo::EventEmitter->new;
+  package main;
 
-  # Subscribe to events
-  $e->on(test => sub {
-    my ($self, $message) = @_;
-    say "test: $message";
+  my $tiger = Cat->new;
+
+  $tiger->on(roar => sub {
+    my ($self, $times) = @_;
+    say 'RAWR!' for 1 .. $times;
   });
 
-  # Emit events
-  $e->emit(test => 'Hello!');
+  $tiger->emit(roar => 5);
 
 =head1 DESCRIPTION
 
-L<Mojo::EventEmitter> is the event emitter used by L<Mojo::IOLoop>.
+L<Mojo::EventEmitter> is a simple base class for event emitting objects.
 Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS