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

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

METHODS

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

DIAGNOSTICS

138       Warning: Couldn't remove lockfile $lock: $!
139       Error: Failed to remove expired lockfile $lockfile: $!
140       Warning: Folder already locked with file $lockfile
141       Error: Package $package does not implement $method.
142           Fatal error: the specific package (or one of its superclasses) does
143           not implement this method where it should. This message means that
144           some other related classes do implement this method however the
145           class at hand does not.  Probably you should investigate this and
146           probably inform the author of the package.
147
148       Warning: Removed expired lockfile $lockfile
149

LICENSE

155       Copyrights 2001-2020 by [Mark Overmeer]. For other contributors see
156       ChangeLog.
157
158       This program is free software; you can redistribute it and/or modify it
159       under the same terms as Perl itself.  See http://dev.perl.org/licenses/
160
161
162
163perl v5.36.0                      2022-07-22     Mail::Box::Locker::DotLock(3)