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

1Mail::Box::Locker::NFS(U3s)er Contributed Perl DocumentatMiaoinl::Box::Locker::NFS(3)
2
3
4

NAME

6       Mail::Box::Locker::NFS - lock a folder with a separate file, NFS-safe
7

INHERITANCE

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

SYNOPSIS

14        See Mail::Box::Locker
15

DESCRIPTION

17       Like the "::DotLock" locker, but then in an NFS-safe fashion.  Over
18       NFS, the creation of a file is not atomic.  The "::DotLock" locker
19       depends on an atomic "open" system call, hence in not usable to lock a
20       folder which accessed over NFS.  The "::NFS" locker is therefore more
21       complicated (so therefore slower), but will work for NFS --and for
22       local disks as well.
23

METHODS

25   Constructors
26       Mail::Box::Locker::NFS->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  'NFS'
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           See "Locking" in Mail::Box::Locker
60
61       $obj->lock
62       $obj->unlock
63           See "Locking" in Mail::Box::Locker
64
65   Error handling
66       $obj->AUTOLOAD
67           See "Error handling" in Mail::Reporter
68
69       $obj->addReport(OBJECT)
70           See "Error handling" in Mail::Reporter
71
72       $obj->defaultTrace([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
73           Mail::Box::Locker::NFS->defaultTrace([LEVEL]|[LOGLEVEL,
74           TRACELEVEL]|[LEVEL, CALLBACK])
75
76           See "Error handling" in Mail::Reporter
77
78       $obj->errors
79           See "Error handling" in Mail::Reporter
80
81       $obj->log([LEVEL [,STRINGS]])
82           Mail::Box::Locker::NFS->log([LEVEL [,STRINGS]])
83
84           See "Error handling" in Mail::Reporter
85
86       $obj->logPriority(LEVEL)
87           Mail::Box::Locker::NFS->logPriority(LEVEL)
88
89           See "Error handling" in Mail::Reporter
90
91       $obj->logSettings
92           See "Error handling" in Mail::Reporter
93
94       $obj->notImplemented
95           See "Error handling" in Mail::Reporter
96
97       $obj->report([LEVEL])
98           See "Error handling" in Mail::Reporter
99
100       $obj->reportAll([LEVEL])
101           See "Error handling" in Mail::Reporter
102
103       $obj->trace([LEVEL])
104           See "Error handling" in Mail::Reporter
105
106       $obj->warnings
107           See "Error handling" in Mail::Reporter
108
109   Cleanup
110       $obj->DESTROY
111           See "Cleanup" in Mail::Box::Locker
112
113       $obj->inGlobalDestruction
114           See "Cleanup" in Mail::Reporter
115

DIAGNOSTICS

117       Warning: Folder $folder already locked over nfs
118           Do not try to lock the folder when the application already has the
119           lock: it will give you dead-locks.
120
121       Error: Package $package does not implement $method.
122           Fatal error: the specific package (or one of its superclasses) does
123           not implement this method where it should. This message means that
124           some other related classes do implement this method however the
125           class at hand does not.  Probably you should investigate this and
126           probably inform the author of the package.
127
128       Warning: Removed expired lockfile $filename.
129           A lock file was found which was older than the expiration period as
130           specified with new(timeout).  The lock file was successfully
131           removed.
132
133       Error: Unable to remove expired lockfile $lockfile: $!
134           A lock file was found which was older than the expiration period as
135           specified with the new(timeout) option.  It is impossible to remove
136           that lock file, so we need to wait until it vanishes by some
137           external cause.
138

LICENSE

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