IKC::Specifier(3)

πŸ“¦ version 0.2402, in arch rolling

πŸ’– NAME πŸ’–

Okay so this is IKC::Specifier(3) from the User Contributed Perl Documentation, and it's literally the manual page for POE::Component::IKC::Specifier β€” the IKC event specifer. (Yes, β€œspecifer” is the spelling on this page, and we're keeping it exactly, no cap. 🫢)

✨ SYNOPSIS ✨

Bestie, here's the whole vibe in code:

use POE;
use POE::Component::IKC::Specifier;
$state=specifier_parse('poe://*/timeserver/connect');
print 'The foreign state is '.specifier_name($state);

πŸ¦‹ DESCRIPTION πŸ¦‹

This is a helper module that encapsulates POE IKC specifiers. An IKC specifier is a way of designating either a kernel, a session or a state within a IKC cluster. Slay.

IKC specifiers have the following format:

poe:://kernel/session/state
  • kernel may be a kernel name, a kernel ID, blank (for local kernel), a '*' (all known foreign kernels), or host:port (not currently supported β€” so don't come for it yet, bestie πŸ™ˆ).
  • session may be any session alias that has been published by the foreign kernel.
  • state is a state that has been published by a foreign session.

Examples:

  • "poe://Pulse/timeserver/connect" β€” State 'connect' in session 'timeserver' on kernel 'Pulse'.
  • "poe:/timeserver/connect" β€” State 'connect' in session 'timeserver' on the local kernel.
  • "poe://*/timeserver/connect" β€” State 'connect' in session 'timeserver' on any known foreign kernel.
  • "poe://Billy/bob/" β€” Session 'bob' on foreign kernel 'Billy'.

πŸ› οΈ EXPORTED FUNCTIONS πŸ› οΈ

These are the exported functions, and they're serving. πŸ’…

🌟 specifier_parse($spec) 🌟

Turn a specifier into the internal representation (hash ref). Returns undef() if the specifier wasn't valid.

print Dumper specifer_parse('poe://Pulse/timeserver/time');

would print

$VAR1 = {
    kernel => 'Pulse',
    session => 'timeserver',
    state => 'time',
};

Note: the internal representation might very well change some day. Forewarned is forearmed, bestie. πŸ’…

🌟 specifier_name($spec) 🌟

Turns a specifier into a string. That's it, that's the function. ✨

πŸ› BUGS πŸ›

No bugs are listed here β€” the BUGS section is literally empty in the original. πŸ›βœ¨ Which is honestly iconic.

πŸ‘‘ AUTHOR πŸ‘‘

Shoutout to the author: Philip Gwyn, <perl-ikc at pied.nu>

Copyright 1999-2014 by Philip Gwyn. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <http://www.perl.com/language/misc/Artistic.html>

πŸ”— SEE ALSO πŸ”—

  • POE
  • POE::Component::IKC::Responder

Okay bye bestie πŸ’– This was the IKC::Specifier(3) page, source/version perl v5.42.0, dated 2025-12-14. Mwah 🫢

πŸ“¦ where this page comes from