Permalink
Browse files

updated docs

  • Loading branch information...
1 parent 53cd540 commit 6569e471bf1da4cbd09b59c4e35b32f387a85dd0 @rcaputo committed Aug 18, 1998
View
@@ -3,8 +3,6 @@
package POE::Driver;
-my $VERSION = 1.0;
-
use strict;
#------------------------------------------------------------------------------
View
@@ -3,8 +3,6 @@
package POE::Driver::SysRW;
-my $VERSION = 1.0;
-
use strict;
use POSIX qw(EAGAIN);
View
@@ -3,8 +3,6 @@
package POE::Filter;
-my $VERSION = 1.0;
-
use strict;
#------------------------------------------------------------------------------
View
@@ -3,8 +3,6 @@
package POE::Filter::Line;
-my $VERSION = 1.0;
-
use strict;
#------------------------------------------------------------------------------
View
@@ -3,8 +3,6 @@
package POE::Kernel;
-my $VERSION = 1.0;
-
use strict;
use POSIX qw(EINPROGRESS EINTR);
use IO::Select;
@@ -683,6 +681,20 @@ Registers a CODE reference (C<$state_code>) for the event C<$state_name> in
the currently active C<POE::Session>. If C<$state_code> is undefined, then
the named state will be removed.
+=item $kernel->alarm($state_name, $time, @etc)
+
+Posts a state for a specific future time, with possible extra parameters. The
+time is represented as system time, just like C<time()> returns. If C<$time>
+is zero, then the alarm is cleared. Otherwise C<$time> is clipped to no
+earlier than the current C<time()>.
+
+The current session will receive its C<$state_name> event when C<time()>
+catches up with C<$time>.
+
+Any given C<$state_name> may only have one alarm pending. Setting a subsequent
+alarm for an existing state will clear all pending events for that state, even
+if the existing states were not enqueued by previous calls to C<alarm()>.
+
=back
=head1 PROTECTED METHODS
View
@@ -3,8 +3,6 @@
package POE::Session;
-my $VERSION = 1.0;
-
use strict;
use Carp;
View
@@ -3,8 +3,6 @@
package POE::Wheel;
-my $VERSION = 1.0;
-
use strict;
#------------------------------------------------------------------------------
@@ -3,8 +3,6 @@
package POE::Wheel::ListenAccept;
-my $VERSION = 1.0;
-
use strict;
use Carp;
use POSIX qw(EAGAIN);
@@ -3,8 +3,6 @@
package POE::Wheel::ReadWrite;
-my $VERSION = 1.0;
-
use strict;
use Carp;

0 comments on commit 6569e47

Please sign in to comment.