{
    "mode": "perldoc",
    "parameter": "Mail::Box::Locker::DotLock",
    "section": "",
    "url": "https://www.chedong.com/phpMan.php/perldoc/Mail%3A%3ABox%3A%3ALocker%3A%3ADotLock/json",
    "generated": "2026-06-12T13:09:27Z",
    "synopsis": "See Mail::Box::Locker",
    "sections": {
        "NAME": {
            "content": "Mail::Box::Locker::DotLock - lock a folder with a separate file\n",
            "subsections": []
        },
        "INHERITANCE": {
            "content": "Mail::Box::Locker::DotLock\nis a Mail::Box::Locker\nis a Mail::Reporter\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "See Mail::Box::Locker\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "The \"::DotLock\" object lock the folder by creating a file with the same name as the folder,\nextended by \".lock\".\n\nExtends \"DESCRIPTION\" in Mail::Box::Locker.\n",
            "subsections": []
        },
        "METHODS": {
            "content": "Extends \"METHODS\" in Mail::Box::Locker.\n",
            "subsections": [
                {
                    "name": "Constructors",
                    "content": "Extends \"Constructors\" in Mail::Box::Locker.\n\nMail::Box::Locker::DotLock->new(%options)\nName of the file to lock. By default, the folder's name is extended with \".lock\".\n\n-Option      --Defined in       --Default\ndotlockfile                     <undef>\nexpires       Mail::Box::Locker  1 hour\nfile          Mail::Box::Locker  <folderfile>.lock\nfolder        Mail::Box::Locker  <undef>\nlog           Mail::Reporter     'WARNINGS'\nmethod        Mail::Box::Locker  'DOTLOCK'\ntimeout       Mail::Box::Locker  10\ntrace         Mail::Reporter     'WARNINGS'\n\ndotlockfile => FILENAME\nAlternative name for \"file\", especially useful to confusion when the multi locker is used.\n\nexpires => SECONDS\nfile => FILENAME\nfolder => FOLDER\nlog => LEVEL\nmethod => STRING|CLASS|ARRAY\ntimeout => SECONDS|'NOTIMEOUT'\ntrace => LEVEL\n"
                },
                {
                    "name": "Attributes",
                    "content": "Extends \"Attributes\" in Mail::Box::Locker.\n\n$obj->expires( [SECONDS] )\nInherited, see \"Attributes\" in Mail::Box::Locker\n\n$obj->timeout( [SECONDS] )\nInherited, see \"Attributes\" in Mail::Box::Locker\n"
                },
                {
                    "name": "The Locker",
                    "content": "Extends \"The Locker\" in Mail::Box::Locker.\n\n$obj->filename( [$filename] )\nInherited, see \"The Locker\" in Mail::Box::Locker\n\n$obj->folder( [$folder] )\nInherited, see \"The Locker\" in Mail::Box::Locker\n\n$obj->name()\nInherited, see \"The Locker\" in Mail::Box::Locker\n"
                },
                {
                    "name": "Locking",
                    "content": "Extends \"Locking\" in Mail::Box::Locker.\n\n$obj->hasLock()\nInherited, see \"Locking\" in Mail::Box::Locker\n\n$obj->isLocked()\nInherited, see \"Locking\" in Mail::Box::Locker\n\n$obj->lock()\n$obj->unlock()\n"
                },
                {
                    "name": "Error handling",
                    "content": "Extends \"Error handling\" in Mail::Box::Locker.\n\n$obj->AUTOLOAD()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->addReport($object)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )\nMail::Box::Locker::DotLock->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback]\n)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->errors()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->log( [$level, [$strings]] )\nMail::Box::Locker::DotLock->log( [$level, [$strings]] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logPriority($level)\nMail::Box::Locker::DotLock->logPriority($level)\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logSettings()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->notImplemented()\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->report( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->reportAll( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->trace( [$level] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->warnings()\nInherited, see \"Error handling\" in Mail::Reporter\n"
                },
                {
                    "name": "Cleanup",
                    "content": "Extends \"Cleanup\" in Mail::Box::Locker.\n\n$obj->DESTROY()\nInherited, see \"Cleanup\" in Mail::Box::Locker\n"
                }
            ]
        },
        "DIAGNOSTICS": {
            "content": "Warning: Couldn't remove lockfile $lock: $!\nError: Failed to remove expired lockfile $lockfile: $!\nWarning: Folder already locked with file $lockfile\nError: Package $package does not implement $method.\nFatal error: the specific package (or one of its superclasses) does not implement this\nmethod where it should. This message means that some other related classes do implement this\nmethod however the class at hand does not. Probably you should investigate this and probably\ninform the author of the package.\n\nWarning: Removed expired lockfile $lockfile\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "This module is part of Mail-Box distribution version 3.009, built on August 18, 2020. Website:\nhttp://perl.overmeer.net/CPAN/\n",
            "subsections": []
        },
        "LICENSE": {
            "content": "Copyrights 2001-2020 by [Mark Overmeer]. For other contributors see ChangeLog.\n\nThis program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself. See http://dev.perl.org/licenses/\n",
            "subsections": []
        }
    },
    "summary": "Mail::Box::Locker::DotLock - lock a folder with a separate file",
    "flags": [],
    "examples": [],
    "see_also": []
}