Permalink
Browse files

Added a bit of documentation about the new immediate option as well a…

…s how POE::NFA operates by default.
  • Loading branch information...
1 parent 7f09336 commit ffbd225a86a8ce5b919afa576a610c8cd0af33fc @hubie hubie committed Apr 24, 2012
Showing with 5 additions and 0 deletions.
  1. +5 −0 lib/POE/NFA.pm
View
5 lib/POE/NFA.pm
@@ -985,6 +985,11 @@ event's handler via C<ARG0..$#_>.
# Switch to the next state; call an entry point with some values.
$_[MACHINE]->goto_state( 'next_state', 'entry_event', @parameters );
+State transitions are not necessarily executed immediately by default. Rather,
+they are placed in POEs event queue behind any currently pending events.
+Enabling the C<immediate> option causes state transitions to occur immediately,
+regardless of any queued events.
+
=head2 stop
stop() forces a machine to stop. The machine will also stop

0 comments on commit ffbd225

Please sign in to comment.