.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "POE::Component::DebugShell 3"
.TH POE::Component::DebugShell 3 "2008-01-07" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
POE::Component::DebugShell \- Component to allow interactive peeking into a 
running POE application
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use POE::Component::DebugShell;
.Ve
.PP
.Vb 1
\&    POE::Component::DebugShell->spawn();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This component allows for interactive peeking into a running \s-1POE\s0
application.
.PP
\&\f(CW\*(C`spawn()\*(C'\fR creates a ReadLine enabled shell equipped with various debug
commands. The following commands are available.
.SH "COMMANDS"
.IX Header "COMMANDS"
.Sh "show_sessions"
.IX Subsection "show_sessions"
.Vb 3
\& debug> show_sessions
\&    * 3 [ session 3 (POE::Component::DebugShell controller) ]
\&    * 2 [ session 2 (PIE, PIE2) ]
.Ve
.PP
Show a list of all sessions in the system. The output format is in the
form of loggable session ids.
.Sh "session_stats"
.IX Subsection "session_stats"
.Vb 4
\& debug> session_stats 2
\&    Statistics for Session 2
\&        Events coming from: 1
\&        Events going to: 1
.Ve
.PP
Display various statistics for a given session. Provide one session id
as a parameter.
.Sh "list_aliases"
.IX Subsection "list_aliases"
.Vb 4
\& debug> list_aliases 2
\&    Alias list for session 2
\&        * PIE
\&        * PIE2
.Ve
.PP
List aliases for a given session id. Provide one session id as a
parameter.
.Sh "queue_dump"
.IX Subsection "queue_dump"
.Vb 8
\& debug> queue_dump
\&    Event Queue:
\&        * ID: 738 - Index: 0
\&            Priority: 1078459009.06715
\&            Event: _sigchld_poll
\&        * ID: 704 - Index: 1
\&            Priority: 1078459012.42691
\&            Event: ping
.Ve
.PP
Dump the contents of the event queue. Add a \f(CW\*(C`\-v\*(C'\fR parameter to get
verbose output.
.Sh "help"
.IX Subsection "help"
.Vb 3
\& debug> help
\&    The following commands are available:
\&        ...
.Ve
.PP
Display help about available commands.
.Sh "status"
.IX Subsection "status"
.Vb 5
\& debug> status
\&    This is POE::Component::DebugShell v1.14
\&    running inside examples/foo.perl.
\&    This console spawned at Thu Mar 4 22:51:51 2004.
\&    There are 3 known sessions (including the kernel).
.Ve
.PP
General shell status.
.Sh "reload"
.IX Subsection "reload"
.Vb 2
\& debug> reload
\& Reloading...
.Ve
.PP
Reload the shell
.Sh "exit"
.IX Subsection "exit"
.Vb 2
\& debug> exit
\& Exiting...
.Ve
.PP
Exit the shell
.SH "DEVELOPERS"
.IX Header "DEVELOPERS"
For you wacky developers, I've provided access to the raw command data
via the \f(CW\*(C`_raw_commands\*(C'\fR method. The underbar at the beginning should 
let you know that this is an experimental interface for developers only. 
.PP
\&\f(CW\*(C`_raw_commands\*(C'\fR returns a hash reference. The keys of this hash are the
command names. The values are a hash of data about the command. This
hash contains the following data:
.IP "* short_help" 4
.IX Item "short_help"
Short help text
.IP "* help" 4
.IX Item "help"
Long help text
.IP "* cmd" 4
.IX Item "cmd"
Code reference for the command. This command requires that a hash be
passed to it containing an \f(CW\*(C`api\*(C'\fR parameter, which is a 
\&\f(CW\*(C`POE::API::Peek\*(C'\fR object, and an \f(CW\*(C`args\*(C'\fR parameter, which is an array
reference of arguments (think \f(CW@ARGV\fR).
.SH "AUTHOR"
.IX Header "AUTHOR"
Matt Cashner (cpan@eekeek.org)
.SH "DATE"
.IX Header "DATE"
$Date: 2004/03/07 01:45:47 $
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2003\-2004, Matt Cashner
.Sp
Permission is hereby granted, free of charge, to any person obtaining 
a copy of this software and associated documentation files (the 
\&\*(L"Software\*(R"), to deal in the Software without restriction, including 
without limitation the rights to use, copy, modify, merge, publish, 
distribute, sublicense, and/or sell copies of the Software, and to 
permit persons to whom the Software is furnished to do so, subject 
to the following conditions:
.Sp
The above copyright notice and this permission notice shall be included 
in all copies or substantial portions of the Software.
.Sp
\&\s-1THIS\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1PROVIDED\s0 \s-1BY\s0 \s-1THE\s0 \s-1AUTHOR\s0 ``\s-1AS\s0 \s-1IS\s0'' \s-1AND\s0 \s-1ANY\s0 \s-1EXPRESS\s0 \s-1OR\s0 \s-1IMPLIED\s0
\&\s-1WARRANTIES\s0, \s-1INCLUDING\s0, \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0, \s-1THE\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0
\&\s-1MERCHANTABILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0 \s-1ARE\s0 \s-1DISCLAIMED\s0. \s-1IN\s0 \s-1NO\s0
\&\s-1EVENT\s0 \s-1SHALL\s0 \s-1THE\s0 \s-1AUTHOR\s0 \s-1BE\s0 \s-1LIABLE\s0 \s-1FOR\s0 \s-1ANY\s0 \s-1DIRECT\s0, \s-1INDIRECT\s0, \s-1INCIDENTAL\s0,
\&\s-1SPECIAL\s0, \s-1EXEMPLARY\s0, \s-1OR\s0 \s-1CONSEQUENTIAL\s0 \s-1DAMAGES\s0 (\s-1INCLUDING\s0, \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0,
\&\s-1PROCUREMENT\s0 \s-1OF\s0 \s-1SUBSTITUTE\s0 \s-1GOODS\s0 \s-1OR\s0 \s-1SERVICES\s0; \s-1LOSS\s0 \s-1OF\s0 \s-1USE\s0, \s-1DATA\s0, \s-1OR\s0 \s-1PROFITS\s0;
\&\s-1OR\s0 \s-1BUSINESS\s0 \s-1INTERRUPTION\s0) \s-1HOWEVER\s0 \s-1CAUSED\s0 \s-1AND\s0 \s-1ON\s0 \s-1ANY\s0 \s-1THEORY\s0 \s-1OF\s0 \s-1LIABILITY\s0,
\&\s-1WHETHER\s0 \s-1IN\s0 \s-1CONTRACT\s0, \s-1STRICT\s0 \s-1LIABILITY\s0, \s-1OR\s0 \s-1TORT\s0 (\s-1INCLUDING\s0 \s-1NEGLIGENCE\s0 \s-1OR\s0
\&\s-1OTHERWISE\s0) \s-1ARISING\s0 \s-1IN\s0 \s-1ANY\s0 \s-1WAY\s0 \s-1OUT\s0 \s-1OF\s0 \s-1THE\s0 \s-1USE\s0 \s-1OF\s0 \s-1THIS\s0 \s-1SOFTWARE\s0, \s-1EVEN\s0 \s-1IF\s0
\&\s-1ADVISED\s0 \s-1OF\s0 \s-1THE\s0 \s-1POSSIBILITY\s0 \s-1OF\s0 \s-1SUCH\s0 \s-1DAMAGE\s0.