1Event::ExecFlow::Job(3)User Contributed Perl DocumentatioEnvent::ExecFlow::Job(3)
2
3
4
6 Event::ExecFlow::Job - Abstract base class for all job classes
7
9 Event::ExecFlow::Job->new (
10 title => Descriptive title,
11 name => Internal short name,
12 depends_on => Names of jobs, this job depends on,
13 progress_max => Maximum expected progress value,
14 progress_ips => String to show as "items per second",
15 no_progress => Job has no progress state at all,
16 pre_callbacks => Callbacks executed before job starts,
17 post_callbacks => Callbacks executed after job finished,
18 error_callbacks => Callbacks executed if job had errors,
19 warning_callbacks => Callbacks executed if job had warnings,
20 stash => A custom data hash stored with the job,
21 );
22
24 This is an abstract base class and usually not used directly from the
25 application. For daily programming the attributes defined in this class
26 are most important, since they are common to all Jobs of the
27 Event::ExecFlow framework.
28
30 Event::ExecFlow
31
32 Event::ExecFlow::Job
33 +--- Event::ExecFlow::Job::Group
34 +--- Event::ExecFlow::Job::Command
35 +--- Event::ExecFlow::Job::Code
36
37 Event::ExecFlow::Frontend
38 Event::ExecFlow::Callbacks
39 Event::ExecFlow::Scheduler
40 +--- Event::ExecFlow::Scheduler::SimpleMax
41
43 Attributes may be set with the new() constructor passed as a hash and
44 accessed at runtime using the common get_ATTR(), set_ATTR() style
45 accessors.
46
47 [ FIXME: describe all attributes in detail ]
48
50 [ FIXME: describe all methods in detail ]
51
53 Jörn Reder <joern at zyn dot de>
54
56 Copyright 2005-2006 by Jörn Reder.
57
58 This library is free software; you can redistribute it and/or modify it
59 under the terms of the GNU Library General Public License as published
60 by the Free Software Foundation; either version 2.1 of the License, or
61 (at your option) any later version.
62
63 This library is distributed in the hope that it will be useful, but
64 WITHOUT ANY WARRANTY; without even the implied warranty of
65 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
66 Library General Public License for more details.
67
68 You should have received a copy of the GNU Library General Public
69 License along with this library; if not, write to the Free Software
70 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307
71 USA.
72
74 Hey! The above document had some coding errors, which are explained
75 below:
76
77 Around line 574:
78 Non-ASCII character seen before =encoding in 'Jörn'. Assuming UTF-8
79
80
81
82perl v5.28.1 2009-12-19 Event::ExecFlow::Job(3)