{
    "content": [
        {
            "type": "text",
            "text": "# Mail::Box::Locker::Multi (perldoc)\n\n## NAME\n\nMail::Box::Locker::Multi - lock a folder in all ways which work\n\n## SYNOPSIS\n\nSee Mail::Box::Locker\n\n## DESCRIPTION\n\nThe \"::Multi\" locker locks a folder in each way it can. This way, the chance is highest that any\nother program will leave the folder alone during our access to it.\n\n## Sections\n\n- **NAME**\n- **INHERITANCE**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **METHODS** (6 subsections)\n- **DIAGNOSTICS**\n- **SEE ALSO**\n- **LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Mail::Box::Locker::Multi",
        "section": "",
        "mode": "perldoc",
        "summary": "Mail::Box::Locker::Multi - lock a folder in all ways which work",
        "synopsis": "See Mail::Box::Locker",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "INHERITANCE",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "METHODS",
                "lines": 2,
                "subsections": [
                    {
                        "name": "Constructors",
                        "lines": 34
                    },
                    {
                        "name": "Attributes",
                        "lines": 8
                    },
                    {
                        "name": "The Locker",
                        "lines": 14
                    },
                    {
                        "name": "Locking",
                        "lines": 14
                    },
                    {
                        "name": "Error handling",
                        "lines": 41
                    },
                    {
                        "name": "Cleanup",
                        "lines": 5
                    }
                ]
            },
            {
                "name": "DIAGNOSTICS",
                "lines": 6,
                "subsections": []
            },
            {
                "name": "SEE ALSO",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "LICENSE",
                "lines": 5,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Mail::Box::Locker::Multi - lock a folder in all ways which work\n",
                "subsections": []
            },
            "INHERITANCE": {
                "content": "Mail::Box::Locker::Multi\nis a Mail::Box::Locker\nis a Mail::Reporter\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "See Mail::Box::Locker\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "The \"::Multi\" locker locks a folder in each way it can. This way, the chance is highest that any\nother program will leave the folder alone during our access to it.\n\nNFS-lock and Flock are tried. More may be added when the ways to lock are extended. DotLock\noverlaps with NFS-lock, but NFS-lock is safer, so that version is preferred.\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::Multi->new(%options)\nYou may also pass all %options understood by the initiated lockers used by the multi locker.\n\n-Option --Defined in       --Default\nexpires  Mail::Box::Locker  1 hour\nfile     Mail::Box::Locker  undef\nfolder   Mail::Box::Locker  <undef>\nlog      Mail::Reporter     'WARNINGS'\nmethod   Mail::Box::Locker  'MULTI'\ntimeout  Mail::Box::Locker  10\ntrace    Mail::Reporter     'WARNINGS'\nuse                         <all possible>\n\nexpires => SECONDS\nfile => FILENAME\nfolder => FOLDER\nlog => LEVEL\nmethod => STRING|CLASS|ARRAY\ntimeout => SECONDS|'NOTIMEOUT'\ntrace => LEVEL\nuse => ARRAY-of-(NAMES|LOCKER)\nArray of locker type NAMES or LOCKER objects to be used to lock one folder. The type NAMES\nare converted into objects. When you create your own LOCKER objects, be sure to set the\ntimeout very short (preferably to 1).\n\nSome locking types are not available on some platforms, so they will not be excluded from\nthe default list (NFS POSIX Flock).\n\nexample: using a subset of multi-lockers\n\nmy $locker = Mail::Box::Locker::Multi->new(use => ['DOTLOCK','FLOCK']);\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->lockers()\nReturns a list with all locker objects used by this object.\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($folder)\nInherited, see \"Locking\" in Mail::Box::Locker\n\n$obj->unlock()\nInherited, see \"Locking\" in Mail::Box::Locker\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::Multi->defaultTrace( [$level]|[$loglevel, $tracelevel]|[$level, $callback] )\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::Multi->log( [$level, [$strings]] )\nInherited, see \"Error handling\" in Mail::Reporter\n\n$obj->logPriority($level)\nMail::Box::Locker::Multi->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": "Error: 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",
                "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": []
            }
        }
    }
}