CAB/Server.pm untested

filter: Statementstmt 0.0% 0 / 69 Branchbran 0.0% 0 / 8 Conditioncond 0.0% 0 / 18 MC/DCmcdc 0.0% 0 / 12 Subroutinesub 0.0% 0 / 15 Podpod 0.0% 0 / 10 totaltotal 0.0% 0 / 132 CC 5 SCAR 14.9
CC
5
Cov
0%
prepare
12.0
prepareSignalHandlers
6.0
finish
6.0
CRAP 4.4
1 ## -*- Mode: CPerl -*-
2 ##
3 ## File: DTA::CAB::Server.pm
4 ## Author: Bryan Jurish <moocow@cpan.org>
5 ## Description: abstract class for DTA::CAB servers
6  
7 package DTA::CAB::Server;
8 use DTA::CAB;
9 use DTA::CAB::Utils qw();
10 use IO::File;
11 use Carp;
12 use strict;
13  
14 ##==============================================================================
15 ## Globals
16 ##==============================================================================
17  
18 our @ISA = qw(DTA::CAB::Persistent DTA::CAB::Logger);
19  
20  
21 ##==============================================================================
22 ## Constructors etc.
23 ##==============================================================================
24  
25 ## $obj = CLASS_OR_OBJ->new(%args)
26 ## + object structure: HASH ref
27 ## {
28 ## as => \%analyzers, ##-- ($name => $cab_analyzer_obj, ...)
29 ## aos => \%anlOptions, ##-- ($name=>\%analyzeOptions, ...) : %opts passed to $anl->analyzeXYZ($xyz,%opts)
30 ## pidfile => $pidfile, ##-- if defined, process PID will be written to $pidfile on prepare()
31 ## pid => $pid, ##-- server PID (default=$$) to write to $pidfile
32 ## ##
33 ## ##-- logging
34 ## logInitAnalyzer => $level, ##-- log analyzer initialization at $level (default='info')
35 ## #...
36 ## }
37 sub new {
38 my $that = shift;
39 my $obj = bless({
40 ##-- dispatch analyzers
41 as => {},
42 aos => {},
43 #pidfile=>undef,
44 #pid=>$pid,
45 ##
46 ##-- logging
47 logInitAnalyzer => 'info',
48 ##
49 ##-- user args
50 @_
51 },
52 ref($that)||$that);
53 $obj->initialize();
54 return $obj;
55 }
56  
57 ## undef = $obj->initialize()
58 ## + called to initialize new objects after new()
59 sub initialize { return $_[0]; }
60  
61 ##==============================================================================
62 ## Methods: Generic Server API
63 ##==============================================================================
64  
65 ## $rc = $srv->prepare()
66 ## + default implementation initializes logger & pre-loads all analyzers
67 sub prepare {
68 my $srv = shift;
69 my $rc = 1;
70  
71 ##-- prepare: logger
72 DTA::CAB::Logger->ensureLog();
73  
74 ##-- prepare: PID file
75 if (defined($srv->{pidfile})) {
76 my $pidfh = IO::File->new(">$srv->{pidfile}")
77 or $srv->logconfess("prepare(): could not write PID file '$srv->{pidfile}': $!");
78 $pidfh->print(($srv->{pid} || $$), "\n");
79 $pidfh->close()
80 }
81  
82 ##-- prepare: analyzers
83 $srv->info("initializing analyzer(s)...");
84 foreach (sort(keys(%{$srv->{as}}))) {
85 $srv->vlog($srv->{logInitAnalyzer},"initializing analyzer '$_'");
86 if (!$srv->{as}{$_}->prepare) {
87 $srv->error("initialization failed for analyzer '$_'; skipping");
88 $rc = 0;
89 }
90 }
91  
92 ##-- prepare: signal handlers
93 $rc &&= $srv->prepareSignalHandlers();
94  
95 ##-- prepare: subclass-local
96 $rc &&= $srv->prepareLocal(@_);
97  
98 ##-- prepare: timestamp
99 $srv->{t_started} //= time();
100  
101 ##-- return
102 $srv->info("initialization complete");
103  
104 return $rc;
105 }
106  
107 ## $rc = $srv->prepareSignalHandlers()
108 ## + initialize signal handlers
109 sub prepareSignalHandlers {
110 my $srv = shift;
111 $SIG{'__DIE__'} = sub {
112 die @_ if ($^S); ##-- normal operation if executing inside an eval{} block
113 $srv->finish();
114 $srv->logconfess("__DIE__ handler called - exiting: ", @_);
115 exit(255);
116 };
117 my $sig_catcher = sub {
118 my $signame = shift;
119 $srv->finish();
120 $srv->logwarn("caught signal SIG$signame - exiting");
121 exit(255);
122 };
123 my ($sig);
124 foreach $sig (qw(TERM KILL QUIT INT HUP ABRT SEGV)) {
125 $SIG{$sig} = $sig_catcher;
126 }
127 #$SIG{$sig} = $sig_catcher foreach $sig (qw(IO URG SYS USR1 USR2)); ##-- DEBUG
128 return $sig_catcher;
129 }
130  
131 ## $rc = $srv->prepareLocal(@args_to_prepare)
132 ## + subclass-local initialization
133 ## + called by prepare() after default prepare() guts have run
134 sub prepareLocal { return 1; }
135  
136  
137 ## $rc = $srv->run()
138 ## + run the server (just a dummy method)
139 sub run {
140 my $srv = shift;
141 $srv->logcroak("run() method not implemented!");
142 $srv->finish(); ##-- cleanup
143 }
144  
145 ## $rc = $srv->finish()
146 ## + cleanup method; should be called when server dies or after run() has completed
147 sub finish {
148 my $srv = shift;
149 delete @SIG{qw(HUP TERM KILL __DIE__)}; ##-- unset signal handlers
150 unlink($srv->{pidfile}) if ($srv->{pidfile});
151 return 1;
152 }
153  
154 ## \%mstat_or_undef = $srv->mstat()
155 sub mstat {
156 return DTA::CAB::Utils::mstat();
157 }
158  
159 ## $memsize_kb_or_undef = $srv->memsize()
160 sub memsize {
161 return DTA::CAB::Utils::memsize();
162 }
163  
164 ## $memrss_kb_or_undef = $srv->memsize()
165 sub memrss {
166 return DTA::CAB::Utils::memrss();
167 }
168  
169 1; ##-- be happy
170  
171 __END__