/ 
Mail-Box-2.015
River stage one • 8 direct dependents • 8 total dependents
/ Mail::Box::Locker::Multi

NAME

Mail::Box::Locker::Multi - lock a folder in all ways which work

CLASS HIERARCHY

Mail::Box::Locker::Multi
is a Mail::Box::Locker
is a Mail::Reporter

SYNOPSIS

See Mail::Box::Locker

DESCRIPTION

The ::Multi locker locks a folder in each way it can. This way, the chance is highest that any other program will leave the folder alone during our access to it.

NFS-lock and Flock are tried. More may be added when the ways to lock are extended. DotLock overlaps with NFS-lock, but NFS-lock is safer, so that version is prefered.

METHOD INDEX

Methods prefixed with an abbreviation are described in Mail::Reporter (MR), Mail::Box::Locker (MBL).

The general methods for Mail::Box::Locker::Multi objects:

MBL DESTROY                          MBL name
 MR errors                               new OPTIONS
MBL filename                          MR report [LEVEL]
MBL hasLock                           MR reportAll [LEVEL]
MBL isLocked                          MR trace [LEVEL]
MBL lock FOLDER                      MBL unlock
 MR log [LEVEL [,STRINGS]]            MR warnings

The extra methods for extension writers:

MR AUTOLOAD                          MR logPriority LEVEL
MR DESTROY                           MR logSettings
MR inGlobalDestruction               MR notImplemented

METHODS

new OPTIONS
OPTIONS        DESCRIBED IN               DEFAULT
file           Mail::Box::Locker          undef
log            Mail::Reporter             'WARNINGS'
method         Mail::Box::Locker          <not used>
expires        Mail::Box::Locker          1 hour
trace          Mail::Reporter             'WARNINGS'
timeout        Mail::Box::Locker          10 seconds
use            Mail::Box::Locker::Multi   [ 'NFS', 'POSIX', 'Flock' ]

  • use => ARRAY

    Array of locker types and locker objects to be used. All types are converted into objects.

    lockers

    Returns a list with all locker objects used by this object.

SEE ALSO

Mail::Box-Overview

For support and additional documentation, see http://perl.overmeer.net/mailbox/

AUTHOR

Mark Overmeer (mailbox@overmeer.net). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

VERSION

This code is beta, version 2.015.

Copyright (c) 2001-2002 Mark Overmeer. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 187:

You forgot a '=back' before '=head1'

You forgot a '=back' before '=head1'