Tirex::Message(3pm)

🌸 Tirex::Message 💌

ok so bestie, welcome to Tirex::Message — part of the User Contributed Perl Documentation, and lowkey the little messenger fairy of the whole Tirex system. it's a message. that's it. that's the vibe. ✨

---

✨ NAME ✨

Tirex::Message — A message 🫶

---

🎀 SYNOPSIS 🎀

my $msg = Tirex::Message->new( ... );

that's it bestie, that's the whole doorway. come on in 💅

---

🦋 DESCRIPTION 🦋

okay so here's the tea: messages are how all the different Tirex components talk to each other — requests go one way, replies come back the other. it's giving group chat but for daemons. 💬

"On the wire" (so literally when they're travelling down the socket, no cap), they're made up of several lines, and those lines are separated by an optional carriage return plus a newline. every single line looks like key=value. and listen — no spaces allowed before or after the key or the equals sign. not one. zero. nada. 🙅♀️

---

👑 METHODS 👑

Tirex::Message->new( type => '...', field1key => "field2value", ... )

make a brand new message, slay. you always need a type for the message — all the other fields are optional, so no pressure on those. ✨

⚠️ will croak if there's no type given. so like… give it a type, bestie. 💀

Tirex::Message->new_from_string("type=foo\nbar=baz\n")

build a message object straight from a string. string in, message out, iconic. 🪄

Tirex::Message->new_from_socket($socket)

read a datagram from the given $socket and make a new message out of it. socket goes in, message comes out. 🌈

$msg->reply([RESULT[, ERRMSG]])

make a new message that's the reply to the old one. if you don't pass RESULT, it just defaults to 'ok'. and if you do pass ERRMSG, it gets attached to the message. 💖

🚫 you can't send a reply to a reply, so if the original message already contains a 'result' field, this method croaks. no infinite reply loops in this house. periodt.

$msg->serialize()

serialize this message into a string with lines in the format key=value. 📝

if a value is undefined, that field just… doesn't get added. we don't talk about it. 🙈

$msg->to_s()

returns the string version of this message — super handy for debugging. format is key=value with the pairs separated by spaces. 🐛

if a value is undefined, that field isn't added here either. ✨

$msg->send($socket, $dest)

send the message through $socket to $dest. go, baby, go 🦋

$msg->to_metatile()

create a metatile from the message. ✨

⚠️ croaks when the message can't be made into a valid metatile. it's not mad, it's just disappointed.

$msg->ok()

is this message a positive reply? it checks for 'result=ok'. 💚

$msg->unknown_message_type()

is this an error message for an unknown message type? it checks for 'result=error_unknown_command'. 🤔

---

and that's the whole page bestie, we ate and left no crumbs 👑

mwah 💋 — this was written by the tirex perl people, and it's perl v5.40.1, dated 2026-08-09. go forth and key=value responsibly. bye bestie!! 💖