Skip to content

Commit

Permalink
relax Mojo::IOLoop and Mojo::Reactor documentation to leave room for …
Browse files Browse the repository at this point in the history
…more reactor backends with different semantics
  • Loading branch information
kraih committed Aug 8, 2012
1 parent 75e3bb9 commit 8193a70
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
7 changes: 3 additions & 4 deletions lib/Mojo/IOLoop.pm
Expand Up @@ -481,8 +481,8 @@ Check if loop is running.
Mojo::IOLoop->one_tick;
$loop->one_tick;
Run reactor until an event occurs or no events are being watched anymore. Note
that this method can recurse back into the reactor, so you need to be careful.
Run reactor until an event occurs. Note that this method can recurse back into
the reactor, so you need to be careful.
=head2 C<recurring>
Expand Down Expand Up @@ -534,8 +534,7 @@ object from everywhere inside the process.
Mojo::IOLoop->start;
$loop->start;
Start the loop, this will block until C<stop> is called or no events are being
watched anymore.
Start the loop, this will block until C<stop> is called.
# Start loop only if it is not running already
Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
Expand Down
8 changes: 3 additions & 5 deletions lib/Mojo/Reactor.pm
Expand Up @@ -125,9 +125,8 @@ Check if reactor is running. Meant to be overloaded in a subclass.
$reactor->one_tick;
Run reactor until an event occurs or no events are being watched anymore. Note
that this method can recurse back into the reactor, so you need to be careful.
Meant to be overloaded in a subclass.
Run reactor until an event occurs. Note that this method can recurse back into
the reactor, so you need to be careful. Meant to be overloaded in a subclass.
# Don't block longer than 0.5 seconds
my $id = $reactor->timer(0.5 => sub {});
Expand Down Expand Up @@ -156,8 +155,7 @@ Remove handle or timer. Meant to be overloaded in a subclass.
$reactor->start;
Start watching for I/O and timer events, this will block until C<stop> is
called or no events are being watched anymore. Meant to be overloaded in a
subclass.
called. Meant to be overloaded in a subclass.
=head2 C<stop>
Expand Down

0 comments on commit 8193a70

Please sign in to comment.