GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MAIL::BOX::LOCKER::FLOCK (3)

.ds Aq ’

NAME

Mail::Box::Locker::Flock - lock a folder using kernel file-locking

CONTENTS

INHERITANCE



 Mail::Box::Locker::Flock
   is a Mail::Box::Locker
   is a Mail::Reporter



SYNOPSIS



 See Mail::Box::Locker



DESCRIPTION

The ::Flock object locks the folder by creating an exclusive lock on the file using the kernel’s flock facilities. This lock is created on a separate file-handle to the folder file, so not the handle which is reading.

File locking does not work in some situations, for instance for operating systems do not support flock.

See documentation in the base class.

METHODS

See documentation in the base class.

    Constructors

See documentation in the base class.
Mail::Box::Locker::Flock-><B>newB>(OPTIONS)


 -Option --Defined in       --Default
  expires  Mail::Box::Locker  1 hour
  file     Mail::Box::Locker  undef
  folder   Mail::Box::Locker  <undef>
  log      Mail::Reporter     WARNINGS
  method   Mail::Box::Locker  FLOCK
  timeout  Mail::Box::Locker  10 seconds
  trace    Mail::Reporter     WARNINGS



expires => SECONDS
file => FILENAME
folder => FOLDER
log => LEVEL
method => STRING|CLASS|ARRAY
timeout => SECONDS|’NOTIMEOUT
trace => LEVEL

    The Locker

See documentation in the base class.
$obj-><B>filenameB>([FILENAME]) See The Locker in Mail::Box::Locker
$obj-><B>folderB>([FOLDER]) See The Locker in Mail::Box::Locker
$obj-><B>nameB>() See The Locker in Mail::Box::Locker

    Locking

See documentation in the base class.
$obj-><B>hasLockB>() See Locking in Mail::Box::Locker
$obj-><B>isLockedB>()
$obj-><B>lockB>()
$obj-><B>unlockB>() See Locking in Mail::Box::Locker

    Error handling

See documentation in the base class.
$obj-><B>AUTOLOADB>() See Error handling in Mail::Reporter
$obj-><B>addReportB>(OBJECT) See Error handling in Mail::Reporter
$obj-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK])
Mail::Box::Locker::Flock-><B>defaultTraceB>([LEVEL]|[LOGLEVEL, TRACELEVEL]|[LEVEL, CALLBACK]) See Error handling in Mail::Reporter
$obj-><B>errorsB>() See Error handling in Mail::Reporter
$obj-><B>logB>([LEVEL [,STRINGS]])
Mail::Box::Locker::Flock-><B>logB>([LEVEL [,STRINGS]]) See Error handling in Mail::Reporter
$obj-><B>logPriorityB>(LEVEL)
Mail::Box::Locker::Flock-><B>logPriorityB>(LEVEL) See Error handling in Mail::Reporter
$obj-><B>logSettingsB>() See Error handling in Mail::Reporter
$obj-><B>notImplementedB>() See Error handling in Mail::Reporter
$obj-><B>reportB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>reportAllB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>traceB>([LEVEL]) See Error handling in Mail::Reporter
$obj-><B>warningsB>() See Error handling in Mail::Reporter

    Cleanup

See documentation in the base class.
$obj-><B>DESTROYB>() See Cleanup in Mail::Box::Locker

DIAGNOSTICS

Warning: Folder $folder already flocked The folder is already locked, but you attempt to lock it again. The behavior of double flock’s is platform dependend, and therefore should not be attempted. The second lock is ignored (but the unlock isn’t)
Error: Package $package does not implement $method. Fatal error: the specific package (or one of its superclasses) does not implement this method where it should. This message means that some other related classes do implement this method however the class at hand does not. Probably you should investigate this and probably inform the author of the package.
Error: Unable to check lock file $filename for $folder: $! To check whether the filename is used to flock a folder, the file must be opened. Apparently this fails, which does not mean that the folder is locked neither that it is unlocked.
Error: Unable to open flock file $filename for $folder: $! For flock-ing a folder it must be opened, which does not succeed for the specified reason.
Error: Will never get a flock at $filename for $folder: $! Tried to flock the folder, but it did not succeed. The error code received from the OS indicates that it will not succeed ever, so we do not need to try again.

SEE ALSO

This module is part of Mail-Box distribution version 2.109, built on August 19, 2013. Website: http://perl.overmeer.net/mailbox/

LICENSE

Copyrights 2001-2013 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MAIL::BOX::LOCKER::FLOCK (3) 2013-08-19

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.