Net::MQ...nstants(3)

💖 Net::MQTT::Constants — the perl page that got its name squished 💖

okay so real talk, this one's filed under User Contributed Perl Documentation and the actual page title is Net::MQTT::Constants — the header just clipped it to Net::MQ...nstants(3) because terminals are dramatic. anyway. hi bestie 🫶

✨ NAME ✨

Net::MQTT::Constants — it's the module that exports all the constants for the MQTT protocol. that's the whole job. it does the job. 💅

🎀 VERSION 🎀

version 1.163170 — yes that number is real, yes it's giving timestamp, no we're not questioning it ⭐

🦋 SYNOPSIS 🦋

one line. one iconic line:

use Net::MQTT::Constants;

that's it. you're in. you're so in. 👑

🌸 DESCRIPTION 🌸

Module to export constants for the MQTT protocol. literally what it says on the tin, no cap. 🍓

🔥 FUNCTIONS 🔥

okay this is the main character section, buckle up. every single one of these bad boys does byte-level work for you so you don't have to, and the offset refs get bumped along the way — yes, they mutate, that's the whole bit, don't come for me 😭

• decode_remaining_length( $data, \$offset ) — works out the "remaining length" from the bytes in $data, starting at the offset it reads from that scalar reference. and then? the offset reference gets incremented by however many bytes it chewed through. it's efficient. it's tidy. we stan. 💜
• encode_remaining_length( $length ) — takes $length and calculates the "remaining length" bytes from it, then hands you back those packed bytes as a string. reverse uno card, slayed. ✨
• decode_byte( $data, \$offset ) — unpacks one single byte out of $data starting at the offset from the scalar reference, and returns it. then bumps the offset reference by the number of bytes processed. one byte. one vibe. 🔥
• encode_byte( $byte ) — returns a packed byte. short king, absolutely no notes. 🧚
• decode_short( $data, \$offset ) — unpacks a short (that's two bytes, bestie) out of $data starting at the offset read from the scalar reference and returns it. offset reference gets incremented by the bytes processed afterwards. 🌈
• encode_short( $short ) — returns a packed short (two bytes). two whole bytes of pure potential. 💫
• decode_string( $data, \$offset ) — unpacks a string out of $data starting at the offset read from the scalar reference and returns it. and what's a string here? a short length followed by that many bytes. the offset reference then gets incremented by the number of bytes processed. it's giving structure. it's giving protocol. 👑
• encode_string( $string ) — returns a packed string — that's the length as a short, and then the bytes of the string right after it. ✨
• qos_string( $qos_value ) — returns a string describing the QoS value you gave it. 🦋
• message_type_string( $message_type_value ) — returns a string describing the message_type value you gave it. 🌸
• dump_string( $data ) — returns a string representation of arbitrary data. if it's all printable characters you get it as a plain string; otherwise you get a hex dump. bestie does both. versatile icon. 💅
• connect_return_code_string( $return_code_value ) — returns a string describing the connect_return_code value you gave it. 🫶

---

👑 AUTHOR 👑

Mark Hindess <soft-cpan@temporalanomaly.com> — the legend himself, we love him, we thank him 💖

💜 COPYRIGHT AND LICENSE 💜

This software is copyright (c) 2014 by Mark Hindess.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. free software fr fr, go wild, but keep the terms. 🙈

---

ngl the "same terms as the Perl 5 programming language system itself" bit is the license, so read it properly before you go shipping things, k? 🎀

and that's the whole page!! sign-off time: this was perl v5.42.2, dated 2026-02-15, page name Net::MQ...nstants(3) — go forth and encode your little bytes, mwah 💋✨🍓