Net::H...istItem(3pm)

✨ Net::Hotline::TrackerListItem 💖

okay bestie, so this is a page from the User Contributed Perl Documentation collection, it lives in section 3pm (that's the perl module manual section, iykyk), and the whole vibe is: it's a lil file object that Net::Hotline::Client uses internally. yes, the full name is Net::Hotline::TrackerListItem and no, it is not secretly abbreviated, that's just the header being extra and truncating it. 🎀

---

🌸 NAME 🌸

Net::Hotline::TrackerListItem — a File object used internally by Net::Hotline::Client. that's it, that's the whole job description. 💅

---

🦋 SYNOPSIS 🦋

here's the energy, literally:

use Net::Hotline::TrackerListItem;

$file = new Net::Hotline::TrackerListItem;

$file->address("hotline.foo.com");
$file->port(5500);
...

so you pull the module in, you make a new one, you start setting attributes. the ... at the end is doing main character energy, it's like "and then whatever else you want bestie". ✨

---

💜 DESCRIPTION 💜

okay so Net::Hotline::TrackerListItem is a simple class — like, refreshingly simple, no drama — for storing and retrieving tracked server information.

here's the part you actually need to hear: you should NEVER have to create your own Net::Hotline::TrackerListItem objects when you're using Net::Hotline::Client. like, not ever. it handles that for you, that's the whole point of it existing. 🙈

what you will be doing is getting attributes, and — to a lesser extent — setting them. that's the whole assignment. getting and setting is all that should ever be necessary, no cap. 🔥

---

🎀 CONSTRUCTION 🎀

• new ADDRESS, PORT, NUM_USERS, NAME, DESCRIPTION — if you hand it exactly five arguments, it creates a brand new Net::Hotline::TrackerListItem object with all the attributes set. 🫶 and if you hand it no arguments at all, it still creates a new Net::Hotline::TrackerListItem object — but every single attribute is set to undef. so it exists, it's just empty inside. relatable honestly. 💀

---

🌈 METHODS 🌈

okay so every single method on Net::Hotline::TrackerListItem is a simple attribute get/set routine. the pattern is so consistent it's iconic:

• if you give it an argument, it sets the attribute.
• in all cases, it returns the current value of the attribute.

that's the entire rule. one rule. periodt. 👑

⭐ the attributes ⭐

• address TEXT — the IP address of the server. where it lives on the internet, basically. 🦋
• port NUM — the port the server is running on. the little door number. 🚪
• num_users NUM — the number of users connected to the server. note the word (claimed) — that's doing a lot of work, because the server says that's how many users there are. we're just reporting the vibe check, not verifying it. 💅
• name TEXT — the server name, as set by the server administrator. like "Ambrosia Software" or "Myth Central". 🌸
• description TEXT — the server description, as set by the server administrator. they wrote it, not us. 🎀

---

🫶 AUTHOR 🫶

John C. Siracusa (siracusa@mindspring.com) — the icon, the legend. 👑

---

💖 COPYRIGHT 💖

Copyright(c) 1999 by John Siracusa. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

bestie reminder: this page came from perl v5.32.0, dated 2021-01-09, and yes the header and footer both insist on abbreviating the module name as Net::H...istItem(3pm) which is giving "we ran out of room on the header line". iconic of them. slay. 💅✨