mail::spamassassin::util::progress(3pm) [debian man page]
Mail::SpamAssassin::Util::Progress(3pm) User Contributed Perl Documentation Mail::SpamAssassin::Util::Progress(3pm)NAME
Mail::SpamAssassin::Util::Progress - Progress bar support for SpamAssassin
SYNOPSIS
my $progress = Mail::SpamAssassin::Util::Progress->new({total => 100});
$msgcount = 0;
foreach my $message (@messages) {
# do something here
$msgcount++;
$progress->update($msgcount);
}
$progress->final();
DESCRIPTION
This module implements a progress bar for use in SpamAssassin scripts and modules. It allows you to create the progress bar, update it and
print out the final results of a particular run.
new
public class (Mail::SpamAssassin::Util::Progress) new (\% $args)
Description: Creates a new Mail::SpamAssassin::Util::Progress object, valid values for the $args hashref are:
total (required)
The total number of messages expected to be processed. This item is required.
fh [optional]
An optional filehandle may be passed in, otherwise STDERR will be used by default.
term [optional]
The module will attempt to determine if a valid terminal exists on the STDIN filehandle. This item allows you to override that value.
init_bar
public instance () init_bar()
Description: This method creates the initial progress bar and is called automatically from new. In addition you can call init_bar on an
existing object to reset the bar to it's original state.
update
public instance () update ([Integer $num_done])
Description: This method is what gets called to update the progress bar. You may optionally pass in an integer value that indicates how
many messages have been processed. If you do not pass anything in then the num_done value will be incremented by one.
final
public instance () final ([Integer $num_done])
Description: This method should be called once all processing has finished. It will print out the final msgs per sec calculation and the
total time taken. You can optionally pass in a num_done value, otherwise it will use the value calculated from the last call to update.
perl v5.14.2 2011-06-06 Mail::SpamAssassin::Util::Progress(3pm)
Check Out this Related Man Page
Mail::SpamAssassin::Util(3pm) User Contributed Perl Documentation Mail::SpamAssassin::Util(3pm)NAME
Mail::SpamAssassin::Util - utility functions
DESCRIPTION
A general class for utility functions. Please use this for functions that stand alone, without requiring a $self object, Portability
functions especially.
NOTE: The functions in this module are to be considered private. Their API may change at any point, and it's expected that they'll only be
used by other Mail::SpamAssassin modules. (TODO: we should probably revisit this if it's useful for plugin development.)
NOTE: Utility functions should not be changing global variables such as $_, $1, $2, ... $/, etc. unless explicitly documented. If these
variables are in use by these functions, they should be localized.
$module = first_available_module (@module_list)
Return the name of the first module that can be successfully loaded with "require" from the list. Returns "undef" if none are
available.
This is used instead of "AnyDBM_File" as follows:
my $module = Mail::SpamAssassin::Util::first_available_module
(qw(DB_File GDBM_File NDBM_File SDBM_File));
tie %hash, $module, $path, [... args];
Note that "SDBM_File" is guaranteed to be present, since it comes with Perl.
my ($filepath, $filehandle) = secure_tmpfile();
Generates a filename for a temporary file, opens it exclusively and securely, and returns a filehandle to the open file (opened
O_RDWR).
If it cannot open a file after 20 tries, it returns "undef".
my ($dirpath) = secure_tmpdir();
Generates a directory for temporary files. Creates it securely and returns the path to the directory.
If it cannot create a directory after 20 tries, it returns "undef".
perl v5.14.2 2011-06-06 Mail::SpamAssassin::Util(3pm)