.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "IKC::Specifier 3pm"
.TH IKC::Specifier 3pm "2011-08-27" "perl v5.12.4" "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"
POE::Component::IKC::Specifier \- IKC event specifer
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&    use POE;
\&    use POE::Component::IKC::Specifier;
\&    $state=specifier_parse(\*(Aqpoe://*/timeserver/connect\*(Aq);
\&    print \*(AqThe foreign state is \*(Aq.specifier_name($state);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a helper module that encapsulates \s-1POE\s0 \s-1IKC\s0 specifiers.  An \s-1IKC\s0
specifier is a way of designating either a kernel, a session or a state
within a \s-1IKC\s0 cluster.
.PP
\&\s-1IKC\s0 specifiers have the folloing format :
.PP
.Vb 1
\&    poe:://kernel/session/state
.Ve
.PP
\&\fBkernel\fR may a kernel name, a kernel \s-1ID\s0, blank (for local kernel), a
\&'*' (all known foreign kernels) or host:port (not currently supported).
.PP
\&\fBsession\fR may be any session alias that has been published by the foreign
kernel.
.PP
\&\fBstate\fR is a state that has been published by a foreign session.
.PP
Examples :
.ie n .IP """poe://Pulse/timeserver/connect""" 4
.el .IP "\f(CWpoe://Pulse/timeserver/connect\fR" 4
.IX Item "poe://Pulse/timeserver/connect"
State 'connect' in session 'timeserver' on kernel 'Pulse'.
.ie n .IP """poe:/timeserver/connect""" 4
.el .IP "\f(CWpoe:/timeserver/connect\fR" 4
.IX Item "poe:/timeserver/connect"
State 'connect' in session 'timeserver' on the local kernel.
.ie n .IP """poe://*/timeserver/connect""" 4
.el .IP "\f(CWpoe://*/timeserver/connect\fR" 4
.IX Item "poe://*/timeserver/connect"
State 'connect' in session 'timeserver' on any known foreign kernel.
.ie n .IP """poe://Billy/bob/""" 4
.el .IP "\f(CWpoe://Billy/bob/\fR" 4
.IX Item "poe://Billy/bob/"
Session 'bob' on foreign kernel 'Billy'.
.SH "EXPORTED FUNCTIONS"
.IX Header "EXPORTED FUNCTIONS"
.ie n .SS """specifier_parse($spec)"""
.el .SS "\f(CWspecifier_parse($spec)\fP"
.IX Subsection "specifier_parse($spec)"
Turn a specifier into the internal representation (hash ref).  Returns
\&\fB\f(BIundef()\fB\fR if the specifier wasn't valid.
.PP
.Vb 1
\&    print Dumper specifer_parse(\*(Aqpoe://Pulse/timeserver/time\*(Aq);
.Ve
.PP
would print
.PP
.Vb 5
\&    $VAR1 = {
\&        kernel => \*(AqPulse\*(Aq,
\&        session => \*(Aqtimeserver\*(Aq,
\&        state => \*(Aqtime\*(Aq,
\&    };
.Ve
.PP
\&\fBNote\fR : the internal representation might very well change some day.
.ie n .SS """specifier_name($spec)"""
.el .SS "\f(CWspecifier_name($spec)\fP"
.IX Subsection "specifier_name($spec)"
Turns a specifier into a string.
.SH "BUGS"
.IX Header "BUGS"
.SH "AUTHOR"
.IX Header "AUTHOR"
Philip Gwyn, <perl\-ikc at pied.nu>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 1999\-2011 by Philip Gwyn.  All rights reserved.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.PP
See <http://www.perl.com/language/misc/Artistic.html>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1POE\s0, POE::Component::IKC::Responder