.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "NDC 3"
.TH NDC 3 "2015-04-19" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Log::Log4perl::NDC \- Nested Diagnostic Context
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Log::Log4perl allows loggers to maintain global thread-specific data, 
called the Nested Diagnostic Context (\s-1NDC\s0).
.PP
At some point, the application might decide to push a piece of
data onto the \s-1NDC\s0 stack, which other parts of the application might 
want to reuse. For example, at the beginning of a web request in a server,
the application might decide to push the \s-1IP\s0 address of the client
onto the stack to provide it for other loggers down the road without
having to pass the data from function to function.
.PP
The Log::Log4perl::Layout::PatternLayout class even provides the handy
\&\f(CW%x\fR placeholder which is replaced by the blank-separated list
of elements currently on the stack.
.PP
This module maintains a simple stack which you can push data on to, query
what's on top, pop it off again or delete the entire stack.
.PP
Its purpose is to provide a thread-specific context which all 
Log::Log4perl loggers can refer to without the application having to
pass around the context data between its functions.
.PP
Since in 5.8.0 perl's threads don't share data only upon request,
global data is by definition thread-specific.
.IP "Log::Log4perl::NDC\->push($text);" 4
.IX Item "Log::Log4perl::NDC->push($text);"
Push an item onto the stack. If the stack grows beyond the defined
limit (\f(CW$Log::Log4perl::NDC::MAX_SIZE\fR), just the topmost element
will be replated.
.Sp
This is typically done when a context is entered.
.IP "Log::Log4perl::NDC\->\fIpop()\fR;" 4
.IX Item "Log::Log4perl::NDC->pop();"
Discard the upmost element of the stack. This is typically done when
a context is left.
.ie n .IP "my $text = Log::Log4perl::NDC\->\fIget()\fR;" 4
.el .IP "my \f(CW$text\fR = Log::Log4perl::NDC\->\fIget()\fR;" 4
.IX Item "my $text = Log::Log4perl::NDC->get();"
Retrieve the content of the stack as a string of blank-separated values
without disrupting the stack structure. Typically done by \f(CW%x\fR.
If the stack is empty the value \f(CW"[undef]"\fR is being returned.
.IP "Log::Log4perl::NDC\->\fIremove()\fR;" 4
.IX Item "Log::Log4perl::NDC->remove();"
Reset the stack, remove all items.
.PP
Please note that all of the methods above are class methods, there's no
instances of this class.
.SH "LICENSE"
.IX Header "LICENSE"
Copyright 2002\-2013 by Mike Schilli <m@perlmeister.com> 
and Kevin Goess <cpan@goess.org>.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
Please contribute patches to the project on Github:
.PP
.Vb 1
\&    http://github.com/mschilli/log4perl
.Ve
.PP
Send bug reports or requests for enhancements to the authors via our
.PP
\&\s-1MAILING LIST \s0(questions, bug reports, suggestions/patches): 
log4perl\-devel@lists.sourceforge.net
.PP
Authors (please contact them via the list above, not directly):
Mike Schilli <m@perlmeister.com>,
Kevin Goess <cpan@goess.org>
.PP
Contributors (in alphabetical order):
Ateeq Altaf, Cory Bennett, Jens Berthold, Jeremy Bopp, Hutton
Davidson, Chris R. Donnelly, Matisse Enzer, Hugh Esco, Anthony
Foiani, James FitzGibbon, Carl Franks, Dennis Gregorovic, Andy
Grundman, Paul Harrington, Alexander Hartmaier  David Hull, 
Robert Jacobson, Jason Kohles, Jeff Macdonald, Markus Peter, 
Brett Rann, Peter Rabbitson, Erik Selberg, Aaron Straup Cope, 
Lars Thegler, David Viner, Mac Yang.