nettool(3tcl)

✨ NAME ✨

nettool — tools for networked applications 🫶 it's the whole vibe, bestie

---

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9
package require nettool ?0.5.4?
package require twapi 3.1
package require ip 0.2
package require platform 0.2

::cat filename

::nettool::allocate_port startingport

::nettool::arp_table

::nettool::broadcast_list

::nettool::claim_port port ?protocol?

::nettool::cpuinfo args

::nettool::find_port startingport

::nettool::hwid_list

::nettool::ip_list

::nettool::mac_list

::nettool::network_list

::nettool::port_busy port

::nettool::release_port port ?protocol?

::nettool::status

::nettool::user_data_root appname

---

💅 DESCRIPTION 💅

okay so nettool is a Pure-tcl set of tools that does all the common network stuff you'd normally need a whole pile of other packages for — or worse, a call out to exec 😭 — except it does it all behind one standard Tcl interface. no cap.

rn it's got reference implementations for these operating systems, and only these: Windows, MacOSX, and Linux (debian). periodt.

---

🎀 COMMANDS 🎀

• ::cat filename — dumps the contents of a file, and that dump is the result. slay.
• ::nettool::allocate_port startingport — tries to allocate startingport, and if that one's busy it just walks the port numbers up one by one until it finds a free one, then claims that port. 💅 it consults a built-in database of known ports so it won't hand you back something that's in common use. (for example: http (80)). icon behaviour tbh.
• ::nettool::arp_table — dumps this computer's Address Resolution Protocol (ARP) table. the result comes back as a Tcl formatted list: macid ipaddrlist ...
• ::nettool::broadcast_list — hands you a list of broadcast addresses (suitable for UDP multicast) that this computer is associated with. go off.
• ::nettool::claim_port port ?protocol? — marks port as busy, optionally as either tcp (that's the default) or udp.
• ::nettool::cpuinfo args — if you pass no arguments, you get back a key/value list describing the CPU of the present machine. included in the matrix is info on how many cores/processors are available for parallel tasking, installed physical RAM, and processor family. 🧚

the exact contents are platform specific, no getting around it:

• for Linux, info is drawn from /proc/cpuinfo and /proc/meminfo.
• for MacOSX, info is drawn from sysctl
• for Windows, info is draw from TWAPI.

if you do give arguments, the result will be a key/value list limited to just the fields you asked for. obsessed.

canonical fields for all platforms:

• cpus — count of CPUs/cores/execution units
• speed — clock speed of processor(s) in Mhz
• memory — installed RAM (in MB)
• vendor — manufacturer

• ::nettool::find_port startingport — returns startingport if it's available, or the next free port after startingport.

⚠️ heads up bestie: unlike ::nettool::allocate_port, this command does not claim the port. it just looks. 👀

it uses a built-in database of known ports to avoid returning a port which is in common use. (for example: http (80))

• ::nettool::hwid_list — returns a list of hardware specific identifiers from this computer. the source and content will vary by platform, literally:
  • for MacOSX, you get the motherboard serial number and macids for all network devices.
  • for Windows, you get the volume serial number of C and macids for all network devices.
  • for Linux, you get macids for all network devices.
• ::nettool::ip_list — returns a list of IP addresses associated with this computer. 💜
• ::nettool::mac_list — returns a list of MACIDs for the network cards attached to this machine. the MACID of the primary network card comes back first. main character card energy 👑
• ::nettool::network_list — returns a list of networks associated with this computer. networks are formated with ip::nativeToPrefix.
• ::nettool::port_busy port — returns true if port is claimed, false otherwise. simple as that. ✨
• ::nettool::release_port port ?protocol? — marks port as not busy, optionally as either tcp (default) or udp.
• ::nettool::status — returns a key/value list describing the status of the computer. the output is designed to be comparable to the output of top for all platforms. 📊

common fields include:

• load — processes per processing unit
• memory_total — total physical RAM (MB)
• memory_free — total physical RAM unused (MB)

• ::nettool::user_data_root appname — returns a fully qualified path to a folder where appname should store it's data.

🙈 important: the path is not created, only computed, by this command. so don't come for me when the folder isn't there, okay?

---

😭 BUGS, IDEAS, FEEDBACK 😭

this document, and the package it describes, will undoubtedly contain bugs and other problems. 💀 please report such in the category odie of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. please also report any ideas for enhancements you may have for either package and/or documentation. we want them fr fr.

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 🌈

nettool, odie

---

⭐ CATEGORY ⭐

System

---

👑 COPYRIGHT 👑

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

---

and that's the whole page, bestie 💖 this was nettool, section 3tcl, shipped out of tcllib at version 0.5.4. go forth and network responsibly 🦋🌸