{
    "content": [
        {
            "type": "text",
            "text": "# Log::Log4perl::Appender::Limit (perldoc)\n\n## NAME\n\nLog::Log4perl::Appender::Limit - Limit message delivery via block period\n\n## SYNOPSIS\n\nuse Log::Log4perl qw(:easy);\nmy $conf = qq(\nlog4perl.category = WARN, Limiter\n# Email appender\nlog4perl.appender.Mailer          = Log::Dispatch::Email::MailSend\nlog4perl.appender.Mailer.to       = drone\\@pageme.com\nlog4perl.appender.Mailer.subject  = Something's broken!\nlog4perl.appender.Mailer.buffered = 0\nlog4perl.appender.Mailer.layout   = PatternLayout\nlog4perl.appender.Mailer.layout.ConversionPattern=%d %m %n\n# Limiting appender, using the email appender above\nlog4perl.appender.Limiter              = Log::Log4perl::Appender::Limit\nlog4perl.appender.Limiter.appender     = Mailer\nlog4perl.appender.Limiter.blockperiod = 3600\n);\nLog::Log4perl->init(\\$conf);\nWARN(\"This message will be sent immediately.\");\nWARN(\"This message will be delayed by one hour.\");\nsleep(3601);\nWARN(\"This message plus the last one will be sent now, separately.\");\n\n## DESCRIPTION\n\n\"appender\"\nSpecifies the name of the appender used by the limiter. The appender specified must be\ndefined somewhere in the configuration file, not necessarily before the definition of\n\"Log::Log4perl::Appender::Limit\".\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **DEVELOPMENT NOTES**\n- **LICENSE**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "Log::Log4perl::Appender::Limit",
        "section": "",
        "mode": "perldoc",
        "summary": "Log::Log4perl::Appender::Limit - Limit message delivery via block period",
        "synopsis": "use Log::Log4perl qw(:easy);\nmy $conf = qq(\nlog4perl.category = WARN, Limiter\n# Email appender\nlog4perl.appender.Mailer          = Log::Dispatch::Email::MailSend\nlog4perl.appender.Mailer.to       = drone\\@pageme.com\nlog4perl.appender.Mailer.subject  = Something's broken!\nlog4perl.appender.Mailer.buffered = 0\nlog4perl.appender.Mailer.layout   = PatternLayout\nlog4perl.appender.Mailer.layout.ConversionPattern=%d %m %n\n# Limiting appender, using the email appender above\nlog4perl.appender.Limiter              = Log::Log4perl::Appender::Limit\nlog4perl.appender.Limiter.appender     = Mailer\nlog4perl.appender.Limiter.blockperiod = 3600\n);\nLog::Log4perl->init(\\$conf);\nWARN(\"This message will be sent immediately.\");\nWARN(\"This message will be delayed by one hour.\");\nsleep(3601);\nWARN(\"This message plus the last one will be sent now, separately.\");",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 25,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 55,
                "subsections": []
            },
            {
                "name": "DEVELOPMENT NOTES",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "LICENSE",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 17,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "Log::Log4perl::Appender::Limit - Limit message delivery via block period\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "use Log::Log4perl qw(:easy);\n\nmy $conf = qq(\nlog4perl.category = WARN, Limiter\n\n# Email appender\nlog4perl.appender.Mailer          = Log::Dispatch::Email::MailSend\nlog4perl.appender.Mailer.to       = drone\\@pageme.com\nlog4perl.appender.Mailer.subject  = Something's broken!\nlog4perl.appender.Mailer.buffered = 0\nlog4perl.appender.Mailer.layout   = PatternLayout\nlog4perl.appender.Mailer.layout.ConversionPattern=%d %m %n\n\n# Limiting appender, using the email appender above\nlog4perl.appender.Limiter              = Log::Log4perl::Appender::Limit\nlog4perl.appender.Limiter.appender     = Mailer\nlog4perl.appender.Limiter.blockperiod = 3600\n);\n\nLog::Log4perl->init(\\$conf);\nWARN(\"This message will be sent immediately.\");\nWARN(\"This message will be delayed by one hour.\");\nsleep(3601);\nWARN(\"This message plus the last one will be sent now, separately.\");\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "\"appender\"\nSpecifies the name of the appender used by the limiter. The appender specified must be\ndefined somewhere in the configuration file, not necessarily before the definition of\n\"Log::Log4perl::Appender::Limit\".\n\n\"blockperiod\"\nPeriod in seconds between delivery of messages. If messages arrive in between, they will be\neither saved (if \"accumulate\" is set to a true value) or discarded (if \"accumulate\" isn't\nset).\n\n\"persistent\"\nFile name in which \"Log::Log4perl::Appender::Limit\" persistently stores delivery times. If\nomitted, the appender will have no recollection of what happened when the program restarts.\n\n\"maxuntilflushed\"\nMaximum number of accumulated messages. If exceeded, the appender flushes all messages,\nregardless if the interval set in \"blockperiod\" has passed or not. Don't mix with\n\"maxuntildiscarded\".\n\n\"maxuntildiscarded\"\nMaximum number of accumulated messages. If exceeded, the appender will simply discard\nadditional messages, waiting for \"blockperiod\" to expire to flush all accumulated messages.\nDon't mix with \"maxuntilflushed\".\n\n\"appendermethodonflush\"\nOptional method name to be called on the appender attached to the limiter when messages are\nflushed. For example, to have the sample code in the SYNOPSIS section bundle buffered emails\ninto one, change the mailer's \"buffered\" parameter to 1 and set the limiters\n\"appendermethodonflush\" value to the string \"flush\":\n\nlog4perl.category = WARN, Limiter\n\n# Email appender\nlog4perl.appender.Mailer          = Log::Dispatch::Email::MailSend\nlog4perl.appender.Mailer.to       = drone\\@pageme.com\nlog4perl.appender.Mailer.subject  = Something's broken!\nlog4perl.appender.Mailer.buffered = 1\nlog4perl.appender.Mailer.layout   = PatternLayout\nlog4perl.appender.Mailer.layout.ConversionPattern=%d %m %n\n\n# Limiting appender, using the email appender above\nlog4perl.appender.Limiter              = Log::Log4perl::Appender::Limit\nlog4perl.appender.Limiter.appender     = Mailer\nlog4perl.appender.Limiter.blockperiod = 3600\nlog4perl.appender.Limiter.appendermethodonflush = flush\n\nThis will cause the mailer to buffer messages and wait for \"flush()\" to send out the whole\nbatch. The limiter will then call the appender's \"flush()\" method when it's own buffer gets\nflushed out.\n\nIf the appender attached to \"Limit\" uses \"PatternLayout\" with a timestamp specifier, you will\nnotice that the message timestamps are reflecting the original log event, not the time of the\nmessage rendering in the attached appender. Major trickery has been applied to accomplish this\n(Cough!).\n",
                "subsections": []
            },
            "DEVELOPMENT NOTES": {
                "content": "\"Log::Log4perl::Appender::Limit\" is a *composite* appender. Unlike other appenders, it doesn't\nlog any messages, it just passes them on to its attached sub-appender. For this reason, it\ndoesn't need a layout (contrary to regular appenders). If it defines none, messages are passed\non unaltered.\n\nCustom filters are also applied to the composite appender only. They are *not* applied to the\nsub-appender. Same applies to appender thresholds. This behaviour might change in the future.\n",
                "subsections": []
            },
            "LICENSE": {
                "content": "Copyright 2002-2013 by Mike Schilli <m@perlmeister.com> and Kevin Goess <cpan@goess.org>.\n\nThis library is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "Please contribute patches to the project on Github:\n\nhttp://github.com/mschilli/log4perl\n\nSend bug reports or requests for enhancements to the authors via our\n\nMAILING LIST (questions, bug reports, suggestions/patches): log4perl-devel@lists.sourceforge.net\n\nAuthors (please contact them via the list above, not directly): Mike Schilli\n<m@perlmeister.com>, Kevin Goess <cpan@goess.org>\n\nContributors (in alphabetical order): Ateeq Altaf, Cory Bennett, Jens Berthold, Jeremy Bopp,\nHutton Davidson, Chris R. Donnelly, Matisse Enzer, Hugh Esco, Anthony Foiani, James FitzGibbon,\nCarl Franks, Dennis Gregorovic, Andy Grundman, Paul Harrington, Alexander Hartmaier David Hull,\nRobert Jacobson, Jason Kohles, Jeff Macdonald, Markus Peter, Brett Rann, Peter Rabbitson, Erik\nSelberg, Aaron Straup Cope, Lars Thegler, David Viner, Mac Yang.\n",
                "subsections": []
            }
        }
    }
}