Framework/Extension/Daemon.pm

filter: Statementstmt 37.5% 18 / 48 Branchbran 0.0% 0 / 10 Conditioncond 0.0% 0 / 3 MC/DCmcdc 0.0% 0 / 2 Subroutinesub 50.0% 4 / 8 Podpod 100% 3 / 3 totaltotal 33.7% 25 / 74 CC 7 SCAR 26.3
CC
7
Cov
30%
daemon_run
30.0
new
12.0
__ANON__
2.0
CRAP 13.9
« Framework/Feature/Run.pm ↑ Summary Framework/Base/Object/ErrorHandle.pm »
1 package App::Framework::Extension::Daemon ;
2  
3 =head1 NAME
4  
5 App::Framework::Daemon - Daemonize an application
6  
7 =head1 SYNOPSIS
8  
9 use App::Framework '::Daemon' ;
10  
11  
12 =head1 DESCRIPTION
13  
14 App::Framework personality that provides a daemonized program (using Net::Server::Daemonize)
15  
16 B<DOCUMENTATION TO BE COMPLETED>
17  
18 B<BETA CODE ONLY - NOT TO BE USED IN PRODUCTION SCRIPTS>
19  
20 =cut
21  
22 1 ▶use strict ;
Subroutine BEGIN: called CC=1 SCAR=0.0
23 1 ▶use Carp ;
Subroutine BEGIN: called CC=1 SCAR=0.0
24  
25 1 our $VERSION = "1.000" ;
26  
27  
28 #============================================================================================
29 # USES
30 #============================================================================================
31 1 ▶use App::Framework::Core ;
Subroutine BEGIN: called CC=1 SCAR=0.0
32 1 ▶use App::Framework::Extension ;
Subroutine BEGIN: called CC=1 SCAR=0.0
33  
34 #============================================================================================
35 # OBJECT HIERARCHY
36 #============================================================================================
37 1 our @ISA ;
38 1 our $PRIORITY = 100 ;
39  
40 #============================================================================================
41 # GLOBALS
42 #============================================================================================
43  
44 # Set of script-related default options
45 1 my @OPTIONS = (
46 # ['log|L=s', 'Log file', 'Specify a log file', ],
47 # ['v|"verbose"', 'Verbose output', 'Make script output more verbose', ],
48 # ['debug=s', 'Set debug level', 'Set the debug level value', ],
49 # ['h|"help"', 'Print help', 'Show brief help message then exit'],
50 # ['man', 'Full documentation', 'Show full man page then exit' ],
51 # ['dryrun|"norun"', 'Dry run', 'Do not execute anything that would alter the file system, just show the commands that would have executed'],
52 ) ;
53  
54 #============================================================================================
55  
56 =head2 FIELDS
57  
58 None
59  
60 =over 4
61  
62 =cut
63  
64 1 my %FIELDS = (
65 ## Object Data
66 'user' => 'nobody',
67 'group' => 'nobody',
68 'pid' => undef,
69 ) ;
70  
71 #============================================================================================
72  
73 =back
74  
75 =head2 CONSTRUCTOR METHODS
76  
77 =over 4
78  
79 =cut
80  
81 #============================================================================================
82  
83  
84 =item B<new([%args])>
85  
86 Create a new App::Framework::Daemon.
87  
88 The %args are specified as they would be in the B<set> method, for example:
89  
90 'mmap_handler' => $mmap_handler
91  
92 The full list of possible arguments are :
93  
94 'fields' => Either ARRAY list of valid field names, or HASH of field names with default values
95  
96 =cut
97  
98 sub new
99 0 ▶{
Subroutine new: not called CC=3 SCAR=24.8
Pod documented
100 0 my ($obj, %args) = @_ ;
101  
102 0 ▶ my $class = ref($obj) || $obj ;
Condition0%0/3
ref $obj || $obj
l!l&&r!l&&!r
000
MC/DC0%0/2
ref $obj || $obj
ref $obj $obj
Truth table0%0/3
A || B
A= ref $objB= $obj
ABresult
1X1
011
000
103  
104 ## Need Net::Server::Daemonize
105 0 eval "use Net::Server::Daemonize;" ;
106 0 ▶ if (@$)
Branch: 1 branch
BranchTrueFalseTotal
if (@$) 0 0 0
107 {
108 0 croak "Sorry. You need to have Net::Server::Daemonize installed to be able to use $class" ;
109 }
110  
111 ## create object dynamically
112 0 my $this = App::Framework::Core->inherit($class, %args) ;
113  
114 ## Set options
115 0 $this->feature('Options')->append_options(\@OPTIONS) ;
116
117 ## hi-jack the app function
118 $this->extend_fn(
119 0 ▶ 'app_fn' => sub {$this->daemon_run(@_);},
Subroutine __ANON__: not called CC=1 SCAR=6.9
120 0 ) ;
121  
122 0 return($this) ;
123 }
124  
125  
126  
127 #============================================================================================
128  
129 =back
130  
131 =head2 CLASS METHODS
132  
133 =over 4
134  
135 =cut
136  
137 #============================================================================================
138  
139 #-----------------------------------------------------------------------------
140  
141 =item B<init_class([%args])>
142  
143 Initialises the object class variables.
144  
145 =cut
146  
147 sub init_class
148 0 ▶{
Subroutine init_class: not called CC=1 SCAR=6.9
Pod documented
149 0 my $class = shift ;
150 0 my (%args) = @_ ;
151  
152 # Add extra fields
153 0 $class->add_fields(\%FIELDS, \%args) ;
154  
155 # init class
156 0 $class->SUPER::init_class(%args) ;
157  
158 }
159  
160  
161 #============================================================================================
162  
163 =back
164  
165 =head2 OBJECT METHODS
166  
167 =over 4
168  
169 =cut
170  
171 #============================================================================================
172  
173  
174 #----------------------------------------------------------------------------
175  
176 =item B<daemon_run()>
177  
178 Daemonize then run the application's app subroutine inside a loop.
179
180 =cut
181  
182  
183 sub daemon_run
184 0 ▶{
Subroutine daemon_run: not called CC=5 SCAR=34.0
Pod documented
185 0 my $this = shift ;
186  
187  
188 0 my $use_net=0;
189 0 ▶if ($use_net)
Branch: 1 branch
BranchTrueFalseTotal
if ($use_net) { } 0 0 0
190 {
191  
192 0 print "Calling daemonize()...\n" ;
193 ## Daemonize
194 0 Net::Server::Daemonize::daemonize(
195 $this->user, # User
196 $this->group, # Group
197 $this->pid, # Path to PID file - optional
198 );
199 0 print "Calling application run...\n" ;
200
201 ## call application run
202 0 $this->call_extend_fn('app_fn') ;
203  
204 }
205  
206 else
207 {
208 ##my $pid = safe_fork();
209 0 print "Calling fork()...\n" ;
210 0 my $pid = fork;
211 0 ▶ unless( defined $pid ){
Branch: 1 branch
BranchTrueFalseTotal
unless (defined $pid) 0 0 0
212 0 die "Couldn't fork: [$!]\n";
213 }
214  
215  
216 ### parent process should do the pid file and exit
217 0 ▶ if( $pid ){
Branch: 1 branch
BranchTrueFalseTotal
if ($pid) { } 0 0 0
218  
219 0 print "Killing parent..\n" ;
220 0 ▶ $pid && exit(0);
Branch: 1 branch
BranchTrueFalseTotal
$pid and exit 0 0 0 0
221  
222  
223 ### child process will continue on
224 }else{
225  
226
227 0 print "Calling application run...\n" ;
228
229 ## call application run
230 0 $this->call_extend_fn('app_fn') ;
231  
232 }
233 }
234  
235  
236  
237 }
238  
239  
240  
241 # ============================================================================================
242 # PRIVATE METHODS
243 # ============================================================================================
244  
245  
246  
247  
248 # ============================================================================================
249 # END OF PACKAGE
250  
251 =back
252  
253 =head1 DIAGNOSTICS
254  
255 Setting the debug flag to level 1 prints out (to STDOUT) some debug messages, setting it to level 2 prints out more verbose messages.
256  
257 =head1 AUTHOR
258  
259 Steve Price C<< <sdprice at cpan.org> >>
260  
261 =head1 BUGS
262  
263 None that I know of!
264  
265 =cut
266  
267  
268 1 1;
269  
270 __END__
« Framework/Feature/Run.pm ↑ Summary Framework/Base/Object/ErrorHandle.pm »