updated docs

hubie · Aug 18, 1998 · 6569e47 · 6569e47
1 parent 53cd540
commit 6569e47
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 18 deletions.
diff --git a/lib/POE/Driver.pm b/lib/POE/Driver.pm
@@ -3,8 +3,6 @@
 
 package POE::Driver;
 
-my $VERSION = 1.0;
-
 use strict;
 
 #------------------------------------------------------------------------------

diff --git a/lib/POE/Driver/SysRW.pm b/lib/POE/Driver/SysRW.pm
@@ -3,8 +3,6 @@
 
 package POE::Driver::SysRW;
 
-my $VERSION = 1.0;
-
 use strict;
 use POSIX qw(EAGAIN);
 

diff --git a/lib/POE/Filter.pm b/lib/POE/Filter.pm
@@ -3,8 +3,6 @@
 
 package POE::Filter;
 
-my $VERSION = 1.0;
-
 use strict;
 
 #------------------------------------------------------------------------------

diff --git a/lib/POE/Filter/Line.pm b/lib/POE/Filter/Line.pm
@@ -3,8 +3,6 @@
 
 package POE::Filter::Line;
 
-my $VERSION = 1.0;
-
 use strict;
 
 #------------------------------------------------------------------------------

diff --git a/lib/POE/Kernel.pm b/lib/POE/Kernel.pm
@@ -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

diff --git a/lib/POE/Session.pm b/lib/POE/Session.pm
@@ -3,8 +3,6 @@
 
 package POE::Session;
 
-my $VERSION = 1.0;
-
 use strict;
 use Carp;
 

diff --git a/lib/POE/Wheel.pm b/lib/POE/Wheel.pm
@@ -3,8 +3,6 @@
 
 package POE::Wheel;
 
-my $VERSION = 1.0;
-
 use strict;
 
 #------------------------------------------------------------------------------

diff --git a/lib/POE/Wheel/ListenAccept.pm b/lib/POE/Wheel/ListenAccept.pm
@@ -3,8 +3,6 @@
 
 package POE::Wheel::ListenAccept;
 
-my $VERSION = 1.0;
-
 use strict;
 use Carp;
 use POSIX qw(EAGAIN);

diff --git a/lib/POE/Wheel/ReadWrite.pm b/lib/POE/Wheel/ReadWrite.pm
@@ -3,8 +3,6 @@
 
 package POE::Wheel::ReadWrite;
 
-my $VERSION = 1.0;
-
 use strict;
 use Carp;