udp...ter(n)

🦋 NAME 🦋

udpcluster — UDP Peer-to-Peer cluster 💖

also, the page itself is titled udp...ter(n) (yes, truncated, we don't make the rules), and its whole ~vibe~ is "Lightweight UDP based tool for cluster node discovery" — so that's the manual name we're folding in right here at the top, bestie 🎀

---

✨ SYNOPSIS ✨

package require Tcl 8.5 9

package require udpcluster ?0.3.4?

package require ip

package require nettool

package require comm

package require interp

package require dicttool

package require cron

---

🌸 DESCRIPTION 🌸

okay so this package is a lightweight alternative to Zeroconf. It uses UDP packets to fill up a table of the services that every node on a local network is offering. Each participant broadcasts a key/value list in plain UTF-8, and that list says which ports are open and which protocols are expected on those ports. And here's the slay part: developers are free to add any additional key/value pairs beyond those ones. no cap, go wild 🫶

---

🎀 Using udpcluster.

For every service you wish to publish, invoke this:

cluster::publish echo@[cluster::macid] {port 10000 protocol echo}

To query what services are available on the local network:

set results [cluster::search PATTERN]
# And inside that result...
echo@LOCALMACID {
   port 10000
   protocol echo
}

To unpublish a service:

cluster::unpublish echo@[cluster::macid]

---

🧚 Historical Notes:

ngl the source page has a sentence that just… stops. It literally reads "Results will" and then the very next thing is the heading Historical Notes:. Not me editing it, not me finishing the thought, I'm just reporting the lore exactly as it was handed to me 💀

This tool was originally known as nns::cluster, but as development progressed, it was clear that it wasn't interacting with any of the other facilities in NNS. periodt. 💅

---

🐛 BUGS, IDEAS, FEEDBACK 🐛

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category nameserv of the Tcllib Trackers: http://core.tcl.tk/tcllib/reportlist. Please also report any ideas for enhancements you may have for either the package and/or the documentation. 🫶

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar. 💖

---

👑 KEYWORDS 👑

• name service
• server

---

🌈 CATEGORY 🌈

Networking

---

💜 COPYRIGHT 💜

Copyright (c) 2016-2018 Sean Woods <yoda@etoyoc.com>

---

and that's the whole page, bestie 💖 it ships from tcllib, version 0.3.4, and the page answers to udp...ter(n). go publish some services, you absolute icon 👑✨🦋