Permalink
Browse files

Adding table to compare delay/alarm and related methods.

  • Loading branch information...
1 parent d65590f commit ca40719e7d2f95ce62f58acc0eb7432eab8045c4 @jmadler jmadler committed with Apr 7, 2011
Showing with 14 additions and 0 deletions.
  1. +14 −0 lib/POE/Kernel.pm
View
@@ -3703,6 +3703,20 @@ There is no delay_remove_all(). Timers are all identical internally,
so alarm_remove_all() clears them all regardless how they were
created.
+=head3 Comparison
+
+Below is a table to help compare the various delayed message-sending methods
+
+ +-----------+------------------+---------------------+------------+
+ | | time argument | clears other events | returns on |
+ | method | passed to method | of the same name | success |
+ +-----------+------------------+---------------------+------------+
+ | delay_set | seconds from now | N | alarm_id |
+ | delay | seconds from now | Y | 0 (false) |
+ | alarm_set | unix epoch time | N | alarm_id |
+ | alarm | unix epoch time | Y | 0 (false) |
+ +-----------+------------------+---------------------+------------+
+
=head2 Session Identifiers (IDs and Aliases)
A session may be referred to by its object references (either blessed

0 comments on commit ca40719

Please sign in to comment.