Xacobeo::Timer(3pm) User Contributed Perl Documentation Xacobeo::Timer(3pm)NAME
Xacobeo::Timer - A custom made timer.
SYNOPSIS
use Xacobeo::Timer;
# As a one time use
my $timer = Xacobeo::Timer->start("Long operation");
do_long_operation();
$timer->elapsed(); # Displays the time elapsed
# A simple stop watch (the destructor displays the time elapsed)
my $TIMER = Xacobeo::Timer->new("Method calls");
sub hotspot {
$TIMER->start();
# Very slow stuff here
$TIMER->stop();
}
DESCRIPTION
This package provides a very simple timer. This timer is used for finding hot spots in the application.
The timer is quite simple it provides the method "start" that starts the timer and the method "stop" that stops the timer and accumulates
the elapsed time. The method "show" can be used to print the time elapsed so far while the method "elapsed" returns the time elapsed so
far.
When an instance of this class dies (because it was undefed or collected by the garbage collector) the builtin Perl desctrutor will
automatically call the method "show". But if the method show or elapsed was called during the lifetime of the instance then the destructor
will not invoke the method show.
METHODS
The package defines the following methods:
new
Creates a new Timer.
Parameters:
o $name (Optional)
The name of the timer.
start
Starts the timer. If this sub is called without a blessed instance then a new Timer will be created.
Parameters:
o $name (optional)
The name is used only when called without a blessed instance.
stop
Stops the timer and adds accumulates the elapsed time. If the timer wasn't started previously this results in a no-op.
show
Prints the elapsed time. This method stops the timer if it was started previously and wasn't stopped.
elapsed
Returns the total time elapsed so far. If the timer was already started the pending time will not be taking into account.
AUTHORS
Emmanuel Rodriguez <potyl@cpan.org>.
COPYRIGHT AND LICENSE
Copyright (C) 2008,2009 by Emmanuel Rodriguez.
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.8 or,
at your option, any later version of Perl 5 you may have available.
perl v5.14.2 2011-11-16 Xacobeo::Timer(3pm)
Check Out this Related Man Page
IO::Async::Timer::Periodic(3pm) User Contributed Perl Documentation IO::Async::Timer::Periodic(3pm)NAME
"IO::Async::Timer::Periodic" - event callback at regular intervals
SYNOPSIS
use IO::Async::Timer::Periodic;
use IO::Async::Loop;
my $loop = IO::Async::Loop->new;
my $timer = IO::Async::Timer::Periodic->new(
interval => 60,
on_tick => sub {
print "You've had a minute
";
},
);
$timer->start;
$loop->add( $timer );
$loop->run;
DESCRIPTION
This subclass of IO::Async::Timer implements repeating events at regular clock intervals. The timing may or may not be subject to how long
it takes the callback to execute. Iterations may be rescheduled runs at fixed regular intervals beginning at the time the timer was
started, or by a fixed delay after the previous code has finished executing.
For a "Timer" object that only runs a callback once, after a given delay, see instead IO::Async::Timer::Countdown. A Countdown timer can
also be used to create repeating events that fire at a fixed delay after the previous event has finished processing. See als the examples
in "IO::Async::Timer::Countdown".
EVENTS
The following events are invoked, either using subclass methods or CODE references in parameters:
on_tick
Invoked on each interval of the timer.
PARAMETERS
The following named parameters may be passed to "new" or "configure":
on_tick => CODE
CODE reference for the "on_tick" event.
interval => NUM
The interval in seconds between invocations of the callback or method. Cannot be changed if the timer is running.
first_interval => NUM
Optional. If defined, the interval in seconds after calling the "start" method before the first invocation of the callback or
method. Thereafter, the regular "interval" will be used. If not supplied, the first interval will be the same as the others.
Even if this value is zero, the first invocation will be made asynchronously, by the containing "Loop" object, and not
synchronously by the "start" method itself.
reschedule => STRING
Optional. Must be one of "hard", "skip" or "drift". Defines the algorithm used to reschedule the next invocation.
"hard" schedules each iteration at the fixed interval from the previous iteration's schedule time, ensuring a regular repeating
event.
"skip" schedules similarly to "hard", but skips over times that have already passed. This matters if the duration is particularly
short and there's a possibility that times may be missed, or if the entire process is stopped and resumed by "SIGSTOP" or similar.
"drift" schedules each iteration at the fixed interval from the time that the previous iteration's event handler returns. This
allows it to slowly drift over time and become desynchronised with other events of the same interval or multiples/fractions of it.
Once constructed, the timer object will need to be added to the "Loop" before it will work. It will also need to be started by the "start"
method.
AUTHOR
Paul Evans <leonerd@leonerd.org.uk>
perl v5.14.2 2012-10-24 IO::Async::Timer::Periodic(3pm)