dnsjit.output.udpcli(3)

💖 dnsjit.output.udpcli — bestie edition 💖

okay so this is dnsjit.output.udpcli, and it lives in section 3 of the Library Functions Manual, which means it's a library function, not a command you type into your shell. got it? good. 🫶

---

✨ NAME ✨

dnsjit.output.udpcli — a Simple and dumb UDP DNS client 💅

---

🌸 SYNOPSIS 🌸

local output = require("dnsjit.output.udpcli").new("127.0.0.1", "53")

---

🦋 DESCRIPTION 🦋

So basically: it's a simple and rather dumb DNS client. and when I say dumb I mean it with love 💖 — it takes any payload you give it and sends the full payload over UDP. that's it. that's the whole personality. no parsing, no thinking, no opinions. it just yeets the bytes. 😌

🎀 Attributes 🎀

• timeout — a core.timespec that gets used when producing objects. ⏰

💜 Functions 💜

• Udpcli.new() — creates a brand new Udpcli output. baby's first client ✨
• Udpcli:timeout(seconds, nanoseconds) — sets the timeout used when producing objects. ⏳
• Udpcli:connect(host, port) — connects to the host and port, and returns 0 if it worked. 🫶
• Udpcli:nonblocking(bool) — turns nonblocking mode on (true) or off (false), returns 0 if it succeeded. and if you don't pass bool at all, it just tells you the current state: true if nonblocking mode is on, false if it's off. very "read the room" of it. 👑
• Udpcli:receive() — returns the C functions and context for receiving objects. and those objects? they get sent. 📤
• Udpcli:produce() — returns the C functions and context for producing objects, and those objects are the ones being received. here's the tea though:
  • if nonblocking mode is enabled, the producer returns a payload object with length zero if there was nothing to receive.
  • if nonblocking mode is disabled, the producer waits for data, and if it times out (see timeout above 👀) it returns a payload object with length zero.
  • and the producer returns nil on error. 😭
• Udpcli:packets() — returns the number of "packets" sent. and yes, "packets" is in scare quotes for a reason: it's actually the number of completely sent payloads. 💀
• Udpcli:received() — returns the number of "packets" received, which is actually the number of successful calls to recvfrom(2) that returned data. same scare quotes, same energy. 🙈
• Udpcli:errors() — returns the number of errors that happened while sending or receiving. hope it stays at zero fr fr 🤞

---

👑 AUTHORS and CONTRIBUTORS 👑

Jerry Lundström (DNS-OARC), Tomáš Křížek (CZ.NIC), Petr Špaček (ISC)

Maintained by DNS-OARC

https://www.dns-oarc.net/

---

💀 BUGS 💀

got issues? got feature requests? bestie, they want to hear it:

https://codeberg.org/DNS-OARC/dnsjit/issues

got questions? need help? slide into the inbox:

admin@dns-oarc.net

no cap, those are the actual places to go. don't just suffer in silence 💖

---

and that's the whole page, periodt. 💅 this was dnsjit version 1.5.1, and the page itself is dnsjit.output.udpcli(3) — go forth and send some payloads, you absolute icon. 🎀✨🦋🌸