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
24       Extends "DESCRIPTION" in Mail::Box::Locker.
25

METHODS

27       Extends "METHODS" in Mail::Box::Locker.
28
29   Constructors
30       Extends "Constructors" in Mail::Box::Locker.
31
32       Mail::Box::Locker::FcntlLock->new(%options)
33            -Option --Defined in       --Default
34             expires  Mail::Box::Locker  1 hour
35             file     Mail::Box::Locker  undef
36             folder   Mail::Box::Locker  <undef>
37             log      Mail::Reporter     'WARNINGS'
38             method   Mail::Box::Locker  FcntlLock
39             timeout  Mail::Box::Locker  10
40             trace    Mail::Reporter     'WARNINGS'
41
42           expires => SECONDS
43           file => FILENAME
44           folder => FOLDER
45           log => LEVEL
46           method => STRING|CLASS|ARRAY
47           timeout => SECONDS|'NOTIMEOUT'
48           trace => LEVEL
49
50   Attributes
51       Extends "Attributes" in Mail::Box::Locker.
52
53       $obj->expires( [SECONDS] )
54           Inherited, see "Attributes" in Mail::Box::Locker
55
56       $obj->timeout( [SECONDS] )
57           Inherited, see "Attributes" in Mail::Box::Locker
58
59   The Locker
60       Extends "The Locker" in Mail::Box::Locker.
61
62       $obj->filename( [$filename] )
63           Inherited, see "The Locker" in Mail::Box::Locker
64
65       $obj->folder( [$folder] )
66           Inherited, see "The Locker" in Mail::Box::Locker
67
68       $obj->name()
69           Inherited, see "The Locker" in Mail::Box::Locker
70
71   Locking
72       Extends "Locking" in Mail::Box::Locker.
73
74       $obj->hasLock()
75           Inherited, see "Locking" in Mail::Box::Locker
76
77       $obj->isLocked()
78       $obj->lock()
79       $obj->unlock()
80           Inherited, see "Locking" in Mail::Box::Locker
81
82   Error handling
83       Extends "Error handling" in Mail::Box::Locker.
84
85       $obj->AUTOLOAD()
86           Inherited, see "Error handling" in Mail::Reporter
87
88       $obj->addReport($object)
89           Inherited, see "Error handling" in Mail::Reporter
90
91       $obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level,
92       $callback] )
93       Mail::Box::Locker::FcntlLock->defaultTrace( [$level]|[$loglevel,
94       $tracelevel]|[$level, $callback] )
95           Inherited, see "Error handling" in Mail::Reporter
96
97       $obj->errors()
98           Inherited, see "Error handling" in Mail::Reporter
99
100       $obj->log( [$level, [$strings]] )
101       Mail::Box::Locker::FcntlLock->log( [$level, [$strings]] )
102           Inherited, see "Error handling" in Mail::Reporter
103
104       $obj->logPriority($level)
105       Mail::Box::Locker::FcntlLock->logPriority($level)
106           Inherited, see "Error handling" in Mail::Reporter
107
108       $obj->logSettings()
109           Inherited, see "Error handling" in Mail::Reporter
110
111       $obj->notImplemented()
112           Inherited, see "Error handling" in Mail::Reporter
113
114       $obj->report( [$level] )
115           Inherited, see "Error handling" in Mail::Reporter
116
117       $obj->reportAll( [$level] )
118           Inherited, see "Error handling" in Mail::Reporter
119
120       $obj->trace( [$level] )
121           Inherited, see "Error handling" in Mail::Reporter
122
123       $obj->warnings()
124           Inherited, see "Error handling" in Mail::Reporter
125
126   Cleanup
127       Extends "Cleanup" in Mail::Box::Locker.
128
129       $obj->DESTROY()
130           Inherited, see "Cleanup" in Mail::Box::Locker
131

DIAGNOSTICS

133       Warning: Folder $folder already lockf'd
134       Error: Package $package does not implement $method.
135           Fatal error: the specific package (or one of its superclasses) does
136           not implement this method where it should. This message means that
137           some other related classes do implement this method however the
138           class at hand does not.  Probably you should investigate this and
139           probably inform the author of the package.
140
141       Error: Unable to check lock file $filename for $folder: $!
142           To check whether the filename is used to flock a folder, the file
143           must be opened.  Apparently this fails, which does not mean that
144           the folder is locked neither that it is unlocked.
145
146       Error: Unable to open FcntlLock lock file $filename for $folder: $!
147           For FcntlLock style locking, a folder it must be opened, which does
148           not succeed for the specified reason.
149
150       Error: Will never get a FcntlLock lock at $filename for $folder: $!
151           Tried to lock the folder, but it did not succeed.  The error code
152           received from the OS indicates that it will not succeed ever, so we
153           do not need to try again.
154

LICENSE

160       Copyrights 2001-2020 by [Mark Overmeer]. For other contributors see
161       ChangeLog.
162
163       This program is free software; you can redistribute it and/or modify it
164       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
165
166
167
168perl v5.34.0                      2022-01-21   Mail::Box::Locker::FcntlLock(3)