1Mail::Box::Locker::DotLUoscekr(3C)ontributed Perl DocumeMnatialt:i:oBnox::Locker::DotLock(3)
2
3
4

NAME

6       Mail::Box::Locker::DotLock - lock a folder with a separate file
7

INHERITANCE

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

SYNOPSIS

14        See Mail::Box::Locker
15

DESCRIPTION

17       The "::DotLock" object lock the folder by creating a file with the same
18       name as the folder, extended by ".lock".
19

METHODS

21       Constructors
22
23       Mail::Box::Locker::DotLock->new(OPTIONS)
24
25        Option --Defined in     --Default
26        expires  Mail::Box::Locker  1 hour
27        file                      <folderfile>.lock
28        folder   Mail::Box::Locker  <required>
29        log      Mail::Reporter   'WARNINGS'
30        method   Mail::Box::Locker  'DOTLOCK'
31        timeout  Mail::Box::Locker  10 seconds
32        trace    Mail::Reporter   'WARNINGS'
33
34           . expires SECONDS
35
36           . file FILENAME
37
38               Name of the file to lock.  By default, the folder's name is
39               extended with ".lock".
40
41           . folder FOLDER
42
43           . log LEVEL
44
45           . method STRING⎪CLASS⎪ARRAY
46
47           . timeout SECONDS⎪'NOTIMEOUT'
48
49           . trace LEVEL
50
51       The Locker
52
53       $obj->filename([FILENAME])
54
55           See "The Locker" in Mail::Box::Locker
56
57       $obj->folder
58
59           See "The Locker" in Mail::Box::Locker
60
61       $obj->name
62
63           See "The Locker" in Mail::Box::Locker
64
65       Locking
66
67       $obj->hasLock
68
69           See "Locking" in Mail::Box::Locker
70
71       $obj->isLocked
72
73           See "Locking" in Mail::Box::Locker
74
75       $obj->lock
76
77       $obj->unlock
78
79       Error handling
80
81       $obj->AUTOLOAD
82
83           See "Error handling" in Mail::Reporter
84
85       $obj->addReport(OBJECT)
86
87           See "Error handling" in Mail::Reporter
88
89       $obj->defaultTrace([LEVEL]⎪[LOGLEVEL, TRACELEVEL]⎪[LEVEL, CALLBACK])
90
91       Mail::Box::Locker::DotLock->defaultTrace([LEVEL]⎪[LOGLEVEL,
92       TRACELEVEL]⎪[LEVEL, CALLBACK])
93
94           See "Error handling" in Mail::Reporter
95
96       $obj->errors
97
98           See "Error handling" in Mail::Reporter
99
100       $obj->log([LEVEL [,STRINGS]])
101
102       Mail::Box::Locker::DotLock->log([LEVEL [,STRINGS]])
103
104           See "Error handling" in Mail::Reporter
105
106       $obj->logPriority(LEVEL)
107
108       Mail::Box::Locker::DotLock->logPriority(LEVEL)
109
110           See "Error handling" in Mail::Reporter
111
112       $obj->logSettings
113
114           See "Error handling" in Mail::Reporter
115
116       $obj->notImplemented
117
118           See "Error handling" in Mail::Reporter
119
120       $obj->report([LEVEL])
121
122           See "Error handling" in Mail::Reporter
123
124       $obj->reportAll([LEVEL])
125
126           See "Error handling" in Mail::Reporter
127
128       $obj->trace([LEVEL])
129
130           See "Error handling" in Mail::Reporter
131
132       $obj->warnings
133
134           See "Error handling" in Mail::Reporter
135
136       Cleanup
137
138       $obj->DESTROY
139
140           See "Cleanup" in Mail::Box::Locker
141
142       $obj->inGlobalDestruction
143
144           See "Cleanup" in Mail::Reporter
145

DIAGNOSTICS

147       Warning: Couldn't remove lockfile $lock: $!
148
149       Error: Failed to remove expired lockfile $lockfile: $!
150
151       Warning: Folder already locked with file $lockfile
152
153       Error: Package $package does not implement $method.
154
155       Fatal error: the specific package (or one of its superclasses) does not
156       implement this method where it should. This message means that some
157       other related classes do implement this method however the class at
158       hand does not.  Probably you should investigate this and probably
159       inform the author of the package.
160
161       Warning: Removed expired lockfile $lockfile
162

SEE ALSO

164       This module is part of Mail-Box distribution version 2.070, built on
165       March 25, 2007. Website: http://perl.overmeer.net/mailbox/
166

LICENSE

168       Copyrights 2001-2007 by Mark Overmeer.For other contributors see
169       ChangeLog.
170
171       This program is free software; you can redistribute it and/or modify it
172       under the same terms as Perl itself.  See
173       http://www.perl.com/perl/misc/Artistic.html
174
175
176
177perl v5.8.8                       2007-03-25     Mail::Box::Locker::DotLock(3)
Impressum