Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
DotLock.pm	2.81 KB	-rw-r--r--
DotLock.pod	5.07 KB	-rw-r--r--
FcntlLock.pm	2.59 KB	-rw-r--r--
FcntlLock.pod	5.46 KB	-rw-r--r--
Flock.pm	2.38 KB	-rw-r--r--
Flock.pod	5.63 KB	-rw-r--r--
Multi.pm	2.43 KB	-rw-r--r--
Multi.pod	5.58 KB	-rw-r--r--
Mutt.pm	2.39 KB	-rw-r--r--
Mutt.pod	5.02 KB	-rw-r--r--
NFS.pm	3.29 KB	-rw-r--r--
NFS.pod	5.51 KB	-rw-r--r--
POSIX.pm	2.71 KB	-rw-r--r--
POSIX.pod	5.82 KB	-rw-r--r--

Code Editor : Multi.pod

=encoding utf8

=head1 NAME

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

=head1 INHERITANCE

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

=head1 SYNOPSIS

See Mail::Box::Locker

=head1 DESCRIPTION

The C<::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 preferred.

Extends L<"DESCRIPTION" in Mail::Box::Locker|Mail::Box::Locker/"DESCRIPTION">.
 
=head1 METHODS

Extends L<"METHODS" in Mail::Box::Locker|Mail::Box::Locker/"METHODS">.
 
=head2 Constructors

Extends L<"Constructors" in Mail::Box::Locker|Mail::Box::Locker/"Constructors">.
 
=over 4

=item Mail::Box::Locker::Multi-E<gt>B<new>(%options)

You may also pass all %options understood by the initiated lockers
used by the multi locker.

-Option --Defined in       --Default
  expires  Mail::Box::Locker  1 hour
  file     Mail::Box::Locker  undef
  folder   Mail::Box::Locker  <undef>
  log      Mail::Reporter     'WARNINGS'
  method   Mail::Box::Locker  'MULTI'
  timeout  Mail::Box::Locker  10
  trace    Mail::Reporter     'WARNINGS'
  use                         <all possible>

=over 2

=item expires => SECONDS

=item file => FILENAME

=item folder => FOLDER

=item log => LEVEL

=item method => STRING|CLASS|ARRAY

=item timeout => SECONDS|'NOTIMEOUT'

=item trace => LEVEL

=item use => ARRAY-of-(NAMES|LOCKER)

Array of locker type NAMES or LOCKER objects to be used to lock one
folder.  The type NAMES are converted into objects.  When you create your
own LOCKER objects, be sure to set the timeout very short (preferably
to 1).

Some locking types are not available on some platforms, so they will
not be excluded from the default list (NFS POSIX Flock).

=back

example: using a subset of multi-lockers

my $locker = Mail::Box::Locker::Multi->new(use => ['DOTLOCK','FLOCK']);

=back

=head2 Attributes

Extends L<"Attributes" in Mail::Box::Locker|Mail::Box::Locker/"Attributes">.
 
=over 4

=item $obj-E<gt>B<expires>( [SECONDS] )

Inherited, see L<Mail::Box::Locker/"Attributes">

=item $obj-E<gt>B<timeout>( [SECONDS] )

Inherited, see L<Mail::Box::Locker/"Attributes">

=back

=head2 The Locker

Extends L<"The Locker" in Mail::Box::Locker|Mail::Box::Locker/"The Locker">.
 
=over 4

=item $obj-E<gt>B<filename>( [$filename] )

Inherited, see L<Mail::Box::Locker/"The Locker">

=item $obj-E<gt>B<folder>( [$folder] )

Inherited, see L<Mail::Box::Locker/"The Locker">

=item $obj-E<gt>B<lockers>()

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

=item $obj-E<gt>B<name>()

Inherited, see L<Mail::Box::Locker/"The Locker">

=back

=head2 Locking

Extends L<"Locking" in Mail::Box::Locker|Mail::Box::Locker/"Locking">.
 
=over 4

=item $obj-E<gt>B<hasLock>()

Inherited, see L<Mail::Box::Locker/"Locking">

=item $obj-E<gt>B<isLocked>()

Inherited, see L<Mail::Box::Locker/"Locking">

=item $obj-E<gt>B<lock>($folder)

Inherited, see L<Mail::Box::Locker/"Locking">

=item $obj-E<gt>B<unlock>()

Inherited, see L<Mail::Box::Locker/"Locking">

=back

=head2 Error handling

Extends L<"Error handling" in Mail::Box::Locker|Mail::Box::Locker/"Error handling">.
 
=over 4

=item $obj-E<gt>B<AUTOLOAD>()