Log::H...Socket(3pm)

💖 Log::Handler::Output::Socket — the perl manpage but make it cute

okay bestie, so this page is from the User Contributed Perl Documentation section of the manual, and it's all about Log::Handler::Output::Socket. Consider this your group chat briefing. 🫶

---

✨ NAME ✨

Log::Handler::Output::Socket — literally just: send messages to a socket. that's the whole vibe. 💌

---

🌸 SYNOPSIS 🌸

use Log::Handler::Output::Socket;

my $sock = Log::Handler::Output::Socket->new(
    peeraddr    => "127.0.0.1",
    peerport    => 44444,
    proto       => "tcp",
    timeout     => 10
);

$sock->log(message => $message);

that's it. that's the whole glow-up. ✨

---

🦋 DESCRIPTION 🦋

with this module you can send messages over the network. yes, like, actually over the network. main character networking energy, no cap. 🔥

---

💅 METHODS 💅

🔧 new()

call new() to create a new Log::Handler::Output::Socket object. it's giving birth but for objects. 🎀

here are all the options you can pass, bestie — don't skip any of them:

• peeraddr — the address of the server. where your message is going, like a little letter. 💌
• peerport — the port to connect to. the specific door you're knocking on. 🚪
• proto — the protocol you wish to use. default is TCP. it's giving classic.
• timeout — the timeout to send a message. default is 5 seconds. don't ghost it for too long or it dips. 😭
• persistent and reconnect — with this option you can enable or disable a persistent connection, and re-connect if the connection was lost. both options are set to 1 on default, so they're already on. iconic defaults tbh. ✨
• dump — do you like to dump the message? 👀 if you enable this option then all messages will be dumped with Data::Dumper. not some. all. periodt.
• dumper — do you want to use another dumper instead of Data::Dumper? yes you can, here's an example:

use Convert::Bencode_XS;

    dumper => sub { Convert::Bencode_XS::bencode($_[0]) }

# or maybe

use JSON::PC;

    dumper => sub { JSON::PC::convert($_[0]) }

• connect — this option is only useful if you want to pass your own arguments to IO::Socket::INET and don't want to use peeraddr and peerhost. it's giving DIY. 🛠️

example:

        connect => {
            PerrAddr  => "127.0.0.1",
            PeerPort  => 44444,
            LocalPort => 44445
        }

(yes, that's PerrAddr exactly as written, we do not touch the code bestie, copying it character-for-character is the whole assignment 💯)

these options are passed to IO::Socket::INET.

📨 log()

call log() if you want to send a message over the socket. this is the moment. the whole reason we're here. 💫

example:

$sock->log("message");

🔌 connect()

connect to the socket. slay, we're online. 🌈

🛑 disconnect()

disconnect from the socket. bye bestie, it was real. 👋

✅ validate()

validate a configuration. making sure everything is correct before we commit — very mature of you. 💜

🔄 reload()

reload with a new configuration. it's giving rebrand. ✨

💀 errstr()

this function returns the last error message. so when something goes wrong, ask errstr() what happened. 😭

---

🎀 PREREQUISITES 🎀

these need to be in the building for any of this to work:

Carp
Params::Validate;
IO::Socket::INET;
Data::Dumper;

---

🍓 EXPORTS 🍓

no exports. nothing to export. empty house. 🙈 (fr fr, it says "No exports." and it means it.)

---

🐞 REPORT BUGS 🐞

please report all bugs to <jschulz.cpan(at)bloonix.de>. 🫶

if you send me a mail then add Log::Handler into the subject. that's the rule, don't forget it. 📬

---

👑 AUTHOR 👑

Jonny Schulz <jschulz.cpan(at)bloonix.de>.

---

📜 COPYRIGHT 📜

Copyright (C) 2007-2009 by Jonny Schulz. All rights reserved.

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

---

just so you know, this page came from the perl v5.36.0 docs, dated 2022-08-28, in the User Contributed Perl Documentation collection. 💖

and that's a wrap, bestie — go send some messages over that socket. you got this. 🦋✨💅