Mail::Box::Locker::FcntlLock(3pm)

1Mail::Box::Locker::FcntUlsLeorckC(o3n)tributed Perl DocuMmaeinlt:a:tBiooxn::Locker::FcntlLock(3)
2
3
4

NAME

6       Mail::Box::Locker::FcntlLock - lock a folder using File::FcntlLock
7

INHERITANCE

9        Mail::Box::Locker::FcntlLock
10          is a Mail::Box::Locker
11          is a Mail::Reporter
12

SYNOPSIS

14        See Mail::Box::Locker
15

DESCRIPTION

17       This locker object is uses File::FcntlLock, and was contributed by Jim
18       in Aus. It is close to Mail::Box::Locker::POSIX, but does work on more
19       systems, for instance Darwin.
20
21       You will need to install File::FcntlLock separately: there is no
22       dependency to it by the MailBox distribution.
23

METHODS

25   Constructors
26       Mail::Box::Locker::FcntlLock->new(OPTIONS)
27            -Option --Defined in     --Default
28             expires  Mail::Box::Locker  1 hour
29             file     Mail::Box::Locker  undef
30             folder   Mail::Box::Locker  <undef>
31             log      Mail::Reporter   'WARNINGS'
32             method   Mail::Box::Locker  FcntlLock
33             timeout  Mail::Box::Locker  10 seconds
34             trace    Mail::Reporter   'WARNINGS'
35
36           expires => SECONDS
37           file => FILENAME
38           folder => FOLDER
39           log => LEVEL
40           method => STRING|CLASS|ARRAY
41           timeout => SECONDS|'NOTIMEOUT'
42           trace => LEVEL
43
44   The Locker
45       $obj->filename([FILENAME])
46           See "The Locker" in Mail::Box::Locker
47
48       $obj->folder([FOLDER])
49           See "The Locker" in Mail::Box::Locker
50
51       $obj->name
52           See "The Locker" in Mail::Box::Locker
53
54   Locking
55       $obj->hasLock
56           See "Locking" in Mail::Box::Locker
57
58       $obj->isLocked
59       $obj->lock
60       $obj->unlock
61           See "Locking" in Mail::Box::Locker
62
63   Error handling
64       $obj->AUTOLOAD
65           See "Error handling" in Mail::Reporter
66
67       $obj->addReport(OBJECT)
68           See "Error handling" in Mail::Reporter
69
70       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
71           Mail::Box::Locker::FcntlLock->defaultTrace([LEVEL]|[LOGLEVEL,
72           TRACELEVEL]|[LEVEL, CALLBACK])
73
74           See "Error handling" in Mail::Reporter
75
76       $obj->errors
77           See "Error handling" in Mail::Reporter
78
79       $obj->log([LEVEL [,STRINGS]])
80           Mail::Box::Locker::FcntlLock->log([LEVEL [,STRINGS]])
81
82           See "Error handling" in Mail::Reporter
83
84       $obj->logPriority(LEVEL)
85           Mail::Box::Locker::FcntlLock->logPriority(LEVEL)
86
87           See "Error handling" in Mail::Reporter
88
89       $obj->logSettings
90           See "Error handling" in Mail::Reporter
91
92       $obj->notImplemented
93           See "Error handling" in Mail::Reporter
94
95       $obj->report([LEVEL])
96           See "Error handling" in Mail::Reporter
97
98       $obj->reportAll([LEVEL])
99           See "Error handling" in Mail::Reporter
100
101       $obj->trace([LEVEL])
102           See "Error handling" in Mail::Reporter
103
104       $obj->warnings
105           See "Error handling" in Mail::Reporter
106
107   Cleanup
108       $obj->DESTROY
109           See "Cleanup" in Mail::Box::Locker
110
111       $obj->inGlobalDestruction
112           See "Cleanup" in Mail::Reporter
113

DIAGNOSTICS

115       Warning: Folder $folder already lockf'd
116       Error: Package $package does not implement $method.
117           Fatal error: the specific package (or one of its superclasses) does
118           not implement this method where it should. This message means that
119           some other related classes do implement this method however the
120           class at hand does not.  Probably you should investigate this and
121           probably inform the author of the package.
122
123       Error: Unable to check lock file $filename for $folder: $!
124           To check whether the filename is used to flock a folder, the file
125           must be opened.  Apparently this fails, which does not mean that
126           the folder is locked neither that it is unlocked.
127
128       Error: Unable to open FcntlLock lock file $filename for $folder: $!
129           For FcntlLock style locking, a folder it must be opened, which does
130           not succeed for the specified reason.
131
132       Error: Will never get a FcntlLock lock at $filename for $folder: $!
133           Tried to lock the folder, but it did not succeed.  The error code
134           received from the OS indicates that it will not succeed ever, so we
135           do not need to try again.
136

LICENSE

142       Copyrights 2001-2011 by Mark Overmeer. For other contributors see
143       ChangeLog.
144
145       This program is free software; you can redistribute it and/or modify it
146       under the same terms as Perl itself.  See
147       http://www.perl.com/perl/misc/Artistic.html
148
149
150
151perl v5.12.3                      2011-01-26   Mail::Box::Locker::FcntlLock(3)