| Current Path : /proc/self/root/proc/2/root/usr/local/share/man/man3/ |
| Current File : //proc/self/root/proc/2/root/usr/local/share/man/man3/IPC::Run3::ProfReporter.3pm |
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "IPC::Run3::ProfReporter 3"
.TH IPC::Run3::ProfReporter 3 "2014-03-29" "perl v5.10.1" "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"
IPC::Run3::ProfReporter \- base class for handling profiling data
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
See IPC::Run3::ProfPP and for an example subclass.
.PP
This class just notes and accumulates times; subclasses use methods like
\&\*(L"handle_app_call\*(R", \*(L"handle_run_exit\*(R" and \*(L"handle_app_exit\*(R" to emit reports on
it. The default methods for these handlers are noops.
.PP
If run from the command line, a reporter will be created and run on
each logfile given as a command line parameter or on run3.out if none
are given.
.PP
This allows reports to be run like:
.PP
.Vb 2
\& perl \-MIPC::Run3::ProfPP \-e1
\& perl \-MIPC::Run3::ProfPP \-e1 foo.out bar.out
.Ve
.PP
Use \*(L"\-\*(R" to read from \s-1STDIN\s0 (the log file format is meant to be moderately
greppable):
.PP
.Vb 1
\& grep "^cvs " run3.out perl \-MIPC::Run3::ProfPP \-e1 \-
.Ve
.PP
Use \-\-app to show only application level statistics (ie don't emit
a report section for each command run).
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP """IPC::Run3::ProfReporter\->new""" 4
.el .IP "\f(CWIPC::Run3::ProfReporter\->new\fR" 4
.IX Item "IPC::Run3::ProfReporter->new"
Returns a new profile reporting object.
.ie n .IP """$reporter\->handle_app_call( ... )""" 4
.el .IP "\f(CW$reporter\->handle_app_call( ... )\fR" 4
.IX Item "$reporter->handle_app_call( ... )"
.PD 0
.ie n .IP """$reporter\->handle_app_exit( ... )""" 4
.el .IP "\f(CW$reporter\->handle_app_exit( ... )\fR" 4
.IX Item "$reporter->handle_app_exit( ... )"
.ie n .IP """$reporter\->handle_run_exit( ... )""" 4
.el .IP "\f(CW$reporter\->handle_run_exit( ... )\fR" 4
.IX Item "$reporter->handle_run_exit( ... )"
.PD
These methods are called by the handled events (see below).
.ie n .IP """$reporter\->app_call(\e@cmd, $time)""" 4
.el .IP "\f(CW$reporter\->app_call(\e@cmd, $time)\fR" 4
.IX Item "$reporter->app_call(@cmd, $time)"
.PD 0
.ie n .IP """$reporter\->app_exit($time)""" 4
.el .IP "\f(CW$reporter\->app_exit($time)\fR" 4
.IX Item "$reporter->app_exit($time)"
.ie n .IP """$reporter\->run_exit(@times)""" 4
.el .IP "\f(CW$reporter\->run_exit(@times)\fR" 4
.IX Item "$reporter->run_exit(@times)"
.PD
.Vb 2
\& $self\->app_call( $time );
\& my $time = $self\->get_app_call_time;
.Ve
.Sp
Sets the time (in floating point seconds) when the application, \fIrun3()\fR,
or \fIsystem()\fR was called or exited. If no time parameter is passed, uses
IPC::Run3's time routine.
.Sp
Use get_...() to retrieve these values (and _accum values, too). This
is a separate method to speed the execution time of the setters just a
bit.
.ie n .IP """$reporter\->get_run_count()""" 4
.el .IP "\f(CW$reporter\->get_run_count()\fR" 4
.IX Item "$reporter->get_run_count()"
.PD 0
.ie n .IP """$reporter\->get_app_call_time()""" 4
.el .IP "\f(CW$reporter\->get_app_call_time()\fR" 4
.IX Item "$reporter->get_app_call_time()"
.ie n .IP """$reporter\->get_app_exit_time()""" 4
.el .IP "\f(CW$reporter\->get_app_exit_time()\fR" 4
.IX Item "$reporter->get_app_exit_time()"
.ie n .IP """$reporter\->get_app_cmd()""" 4
.el .IP "\f(CW$reporter\->get_app_cmd()\fR" 4
.IX Item "$reporter->get_app_cmd()"
.ie n .IP """$reporter\->get_app_time()""" 4
.el .IP "\f(CW$reporter\->get_app_time()\fR" 4
.IX Item "$reporter->get_app_time()"
.ie n .IP """$reporter\->get_app_cumulative_time()""" 4
.el .IP "\f(CW$reporter\->get_app_cumulative_time()\fR" 4
.IX Item "$reporter->get_app_cumulative_time()"
.ie n .IP """$reporter\->get_run_call_time()""" 4
.el .IP "\f(CW$reporter\->get_run_call_time()\fR" 4
.IX Item "$reporter->get_run_call_time()"
.ie n .IP """$reporter\->get_run_exit_time()""" 4
.el .IP "\f(CW$reporter\->get_run_exit_time()\fR" 4
.IX Item "$reporter->get_run_exit_time()"
.ie n .IP """$reporter\->get_run_time()""" 4
.el .IP "\f(CW$reporter\->get_run_time()\fR" 4
.IX Item "$reporter->get_run_time()"
.ie n .IP """$reporter\->get_run_cumulative_time()""" 4
.el .IP "\f(CW$reporter\->get_run_cumulative_time()\fR" 4
.IX Item "$reporter->get_run_cumulative_time()"
.ie n .IP """$reporter\->get_sys_call_time()""" 4
.el .IP "\f(CW$reporter\->get_sys_call_time()\fR" 4
.IX Item "$reporter->get_sys_call_time()"
.ie n .IP """$reporter\->get_sys_exit_time()""" 4
.el .IP "\f(CW$reporter\->get_sys_exit_time()\fR" 4
.IX Item "$reporter->get_sys_exit_time()"
.ie n .IP """$reporter\->get_sys_time()""" 4
.el .IP "\f(CW$reporter\->get_sys_time()\fR" 4
.IX Item "$reporter->get_sys_time()"
.ie n .IP """$reporter\->get_sys_cumulative_time()""" 4
.el .IP "\f(CW$reporter\->get_sys_cumulative_time()\fR" 4
.IX Item "$reporter->get_sys_cumulative_time()"
.ie n .IP """$reporter\->get_run_cmd()""" 4
.el .IP "\f(CW$reporter\->get_run_cmd()\fR" 4
.IX Item "$reporter->get_run_cmd()"
.PD
.SH "LIMITATIONS"
.IX Header "LIMITATIONS"
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 1
\& Copyright 2003, R. Barrie Slaymaker, Jr., All Rights Reserved
.Ve
.SH "LICENSE"
.IX Header "LICENSE"
You may use this module under the terms of the \s-1BSD\s0, Artistic, or \s-1GPL\s0 licenses,
any version.
.SH "AUTHOR"
.IX Header "AUTHOR"
Barrie Slaymaker <barries@slaysys.com>
Copyright 2K16 - 2K18 Indonesian Hacker Rulez
;?>)