.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "POE::Component::Schedule 3pm"
.TH POE::Component::Schedule 3pm "2018-08-24" "perl v5.26.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
POE::Component::Schedule \- Schedule POE events using DateTime::Set iterators
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use POE qw(Component::Schedule);
\&    use DateTime::Set;
\&
\&    POE::Session\->create(
\&        inline_states => {
\&            _start => sub {
\&                $_[HEAP]{sched} = POE::Component::Schedule\->add(
\&                    $_[SESSION], Tick => DateTime::Set\->from_recurrence(
\&                        after      => DateTime\->now,
\&                        before     => DateTime\->now\->add(seconds => 3),
\&                        recurrence => sub {
\&                            return $_[0]\->truncate( to => \*(Aqsecond\*(Aq )\->add( seconds => 1 )
\&                        },
\&                    ),
\&                );
\&            },
\&            Tick => sub {
\&                print \*(Aqtick \*(Aq, scalar localtime, "\en";
\&            },
\&            remove_sched => sub {
\&                # Three ways to remove a schedule
\&                # The first one is only for API compatibility with POE::Component::Cron
\&                $_[HEAP]{sched}\->delete;
\&                $_[HEAP]{sched} = undef;
\&                delete $_[HEAP]{sched};
\&            },
\&            _stop => sub {
\&                print "_stop\en";
\&            },
\&        },
\&    );
\&
\&    POE::Kernel\->run();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This component encapsulates a session that sends events to client sessions
on a schedule as defined by a DateTime::Set iterator.
.SH "POE::Component::Schedule METHODS"
.IX Header "POE::Component::Schedule METHODS"
.SS "spawn(Alias => \fIname\fP)"
.IX Subsection "spawn(Alias => name)"
Start up the PoCo::Schedule background session with the given alias. Returns
the back-end session handle.
.PP
No need to call this in normal use, \f(CW\*(C`add()\*(C'\fR and \f(CW\*(C`new()\*(C'\fR all crank
one of these up if it is needed.
.SS "add(\fI\fP\f(CI$session\fP\fI\fP, \fI\fP\f(CI$event_name\fP\fI\fP, \fI\fP\f(CI$iterator\fP\fI\fP, \fI\fP\f(CI@event_args\fP\fI\fP)"
.IX Subsection "add($session, $event_name, $iterator, @event_args)"
.Vb 6
\&    my $sched = POE::Component::Schedule\->add(
\&        $session,
\&        $event_name,
\&        $DateTime_Set_iterator,
\&        @event_args
\&    );
.Ve
.PP
Add a set of events to the scheduler.
.PP
Returns a schedule handle. The event is automatically deleted when the handle
is not referenced anymore.
.SS "new(\fI\fP\f(CI$session\fP\fI\fP, \fI\fP\f(CI$event_name\fP\fI\fP, \fI\fP\f(CI$iterator\fP\fI\fP, \fI\fP\f(CI@event_args\fP\fI\fP)"
.IX Subsection "new($session, $event_name, $iterator, @event_args)"
\&\f(CW\*(C`new()\*(C'\fR is an alias for \f(CW\*(C`add()\*(C'\fR.
.SH "SCHEDULE HANDLE METHODS"
.IX Header "SCHEDULE HANDLE METHODS"
.SS "\fIdelete()\fP"
.IX Subsection "delete()"
Removes a schedule using the handle returned from \f(CW\*(C`add()\*(C'\fR or \f(CW\*(C`new()\*(C'\fR.
.PP
\&\fB\s-1DEPRECATED\s0\fR: Schedules are now automatically deleted when they are not
referenced anymore. So just setting the container variable to \f(CW\*(C`undef\*(C'\fR will
delete the schedule.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1POE\s0, DateTime::Set, POE::Component::Cron.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can look for information at:
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE\-Component\-Schedule>:
post bug report there.
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/p/POE\-Component\-Schedule>:
if you use this distribution, please add comments on your experience for other
users.
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/POE\-Component\-Schedule/>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/POE\-Component\-Schedule>
.SH "ACKNOWLEDGMENT & HISTORY"
.IX Header "ACKNOWLEDGMENT & HISTORY"
This module was a friendly fork of POE::Component::Cron to extract the
generic parts and isolate the Cron specific code in order to reduce
dependencies on other \s-1CPAN\s0 modules.
.PP
See <https://rt.cpan.org/Ticket/Display.html?id=44442>.
.PP
The original author of POE::Component::Cron is Chris Fedde.
.PP
POE::Component::Cron is now implemented as a class that inherits from
POE::Component::Schedule.
.PP
Most of the POE::Component::Schedule internals have since been rewritten in
0.91_01 and we have now a complete test suite.
.SH "AUTHORS"
.IX Header "AUTHORS"
.ie n .IP "Olivier Mengue\*', ""dolmen@cpan.org""" 4
.el .IP "Olivier Mengue\*', \f(CWdolmen@cpan.org\fR" 4
.IX Item "Olivier Mengue', dolmen@cpan.org"
.PD 0
.ie n .IP "Chris Fedde, ""cfedde@cpan.org""" 4
.el .IP "Chris Fedde, \f(CWcfedde@cpan.org\fR" 4
.IX Item "Chris Fedde, cfedde@cpan.org"
.PD
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.IP "Copyright X 2009\-2010 Olivier Mengue\*'." 4
.IX Item "Copyright X 2009-2010 Olivier Mengue'."
.PD 0
.IP "Copyright X 2007\-2008 Chris Fedde." 4
.IX Item "Copyright X 2007-2008 Chris Fedde."
.PD
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.3 or,
at your option, any later version of Perl 5 you may have available.