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

DIAGNOSTICS

120       Warning: Couldn't remove lockfile $lock: $!
121       Error: Failed to remove expired lockfile $lockfile: $!
122       Warning: Folder already locked with file $lockfile
123       Error: Package $package does not implement $method.
124           Fatal error: the specific package (or one of its superclasses) does
125           not implement this method where it should. This message means that
126           some other related classes do implement this method however the
127           class at hand does not.  Probably you should investigate this and
128           probably inform the author of the package.
129
130       Warning: Removed expired lockfile $lockfile
131

SEE ALSO

133       This module is part of Mail-Box distribution version 2.097, built on
134       January 26, 2011. Website: http://perl.overmeer.net/mailbox/
135

LICENSE

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