POE::C...onsole(3pm)

💅 POE::C...onsole(3pm) — User Contributed Perl Documentation 💅

okay bestie, gather round, because this page is literally called POE::C...onsole(3pm) — yes the title got its nails done and the middle fell off, we love her anyway. She lives in the User Contributed Perl Documentation corner of the manual pages and she's here to hand you a lil backdoor console for your IRC bot. 🎀

---

✨ NAME ✨

POE::Component::IRC::Plugin::Console — a PoCo-IRC plugin that hands your bot a lightweight debugging and control console, no cap. 🦋

---

🌸 SYNOPSIS 🌸

use POE qw(Component::IRC Component::IRC::Plugin::Console);

my $nickname = 'Flibble' . $$;
my $ircname = 'Flibble the Sailor Bot';
my $ircserver = 'irc.blahblahblah.irc';
my $port = 6667;
my $bindport = 6969;

my @channels = ( '#Blah', '#Foo', '#Bar' );

my $irc = POE::Component::IRC->spawn(
    nick => $nickname,
    server => $ircserver,
    port => $port,
    ircname => $ircname,
) or die "Oh noooo! $!";

POE::Session->create(
    package_states => [
        main => [ qw(_start irc_001 irc_console_service irc_console_connect
            irc_console_authed irc_console_close irc_console_rw_fail) ],
        ],
);

$poe_kernel->run();

sub _start {
    $irc->plugin_add( 'Console' => POE::Component::IRC::Plugin::Console->new(
        bindport => $bindport,
        password => 'opensesame'
    );
    $irc->yield( register => 'all' );
    $irc->yield( connect => { } );
    return;
 }

sub irc_001 {
    $irc->yield( join => $_ ) for @channels;
    return;
}

sub irc_console_service {
    my $getsockname = $_[ARG0];
    return;
}

sub irc_console_connect {
    my ($peeradr, $peerport, $wheel_id) = @_[ARG0 .. ARG2];
    return;
}

sub irc_console_authed {
    my $wheel_id = $_[ARG0];
    return;
}

sub irc_console_close {
    my $wheel_id = $_[ARG0];
    return;
}

sub irc_console_rw_fail {
    my ($peeradr, $peerport) = @_[ARG0, ARG1];
    return;
}

like, copy that and you're already main character energy, fr fr. 👑

---

💖 DESCRIPTION 💖

So POE::Component::IRC::Plugin::Console is a POE::Component::IRC plugin that gives you an interactive console, and it runs over the loopback network. Say it with me: loopback, so it stays local, bestie. 🫶

Here's the vibe: you connect to the listening socket with a telnet client (or anything equivalent, we're not gatekeeping), then you authenticate with whichever password applies. Once you're authed — and only once you're authed — you get all the events that get processed through the component. Obsessed. And you can also issue all the documented component commands. It's giving remote control but cozy. 💅

---

🎀 METHODS 🎀

✨ "new" ✨

Takes two arguments:

• 'password' — the password you set for all console connections. every single one. no exceptions, periodt.
• 'bindport' — specify a particular port to bind to; it defaults to 0, ie. randomly allocated. 🎲

Returns a plugin object suitable for feeding to POE::Component::IRC's "plugin_add" method. feed her, she's hungry. 🍓

✨ "getsockname" ✨

Gives you access to the underlying listener's "getsockname" method. See POE::Wheel::SocketFactory for the details, iykyk.

---

🌈 OUTPUT EVENTS 🌈

The plugin generates the following additional POE::Component::IRC events. this is the part where your bot starts talking back, lowkey iconic:

💜 "irc_console_service" 💜

Emitted when a listener is successfully spawned. ARG0 is the result of "getsockname" — see above for details. ⭐

💜 "irc_console_connect" 💜

Emitted when a client connects to the console. ARG0 is the peeradr, ARG1 is the peer port and ARG2 is the wheel id of the connection. three args, slay. ✨

💜 "irc_console_authed" 💜

Emitted when a client has successfully provided a valid password. ARG0 is the wheel id of the connection. 🔐

💜 "irc_console_close" 💜

Emitted when a client terminates a connection. ARG0 is the wheel id of the connection. bye bestie 👋

💜 "irc_console_rw_fail" 💜

Emitted when a POE::Wheel::ReadWrite could not be created on a socket. ARG0 is the peer's address, ARG1 is the peer's port. it's giving sad but we move 💀

---

👑 AUTHOR 👑

Chris 'BinGOs' Williams — the og, the blueprint, we stan. 🙌

---

🌸 SEE ALSO 🌸

• POE::Component::IRC
• POE::Wheel::SocketFactory

---

ngl bestie, remember the rules: the console is password gated, so pick a real one and don't be out here leaving your bot's whole soul exposed on the loopback. security is the vibe check. 🫶

---

and that's the tea, gorgeous 🧚 — this whole thing comes from perl v5.40.1, dated 2025-08-21, and it's filed under POE::C...onsole(3pm) in the User Contributed Perl Documentation. go forth and console, you absolute legend 💖✨🎀