UDPCLI(1)

💫 UDPCLI(1) — bestie edition 💫

okay so this is a page from the BP executables manual, and we're talking about udpcli — the UDP-based Bundle Protocol convergence layer input task. she's a background girlie. she listens. she receives. she slays. 🎀

---

✨ NAME ✨

udpcli — the UDP-based BP convergence layer input task 🦋

---

🌸 SYNOPSIS 🌸

udpcli local_hostname[:local_port_nbr]

---

💖 DESCRIPTION 💖

so basically, udpcli is a background "daemon" task — yes bestie, she's a daemon, she lives in the background and minds her own business 💅 — and what she does is receive UDP datagrams through a UDP socket that's bound to local_hostname and local_port_nbr. then she extracts bundles out of those datagrams and hands them over to the bundle protocol agent on the local ION node. that's the whole gig. iconic behavior, honestly.

if you don't specify it, the port number defaults to 4556. no cap. ✨

now, the convergence layer input task gets spawned automatically by bpadmin when it sees the 's' (START) command that starts operation of the Bundle Protocol. important detail though: the text of the command used to spawn the task has to be provided at the time the "udp" convergence layer protocol is added to the BP database. so like, you can't just spawn her out of nowhere, she needs her paperwork done first 😭

and the convergence layer input task gets terminated by bpadmin in response to an 'x' (STOP) command. also! udpcli can be spawned and terminated in response to START and STOP commands that pertain specifically to the UDP convergence layer protocol. so there's options, she's flexible like that 🫶

---

🔥 EXIT STATUS 🔥

• "0" — udpcli terminated normally, for reasons noted in the ion.log file. but listen: if this termination was not commanded, go investigate and solve the problem identified in the log file, and then use bpadmin to restart udpcli. don't just ignore her, she's telling you something 💀
• "1" — udpcli terminated abnormally, for reasons noted in the ion.log file. investigate and solve the problem identified in the log file, then use bpadmin to restart udpcli.

---

🎀 FILES 🎀

No configuration files are needed. she's low maintenance, we love that for her. ✨

---

🌈 ENVIRONMENT 🌈

No environment variables apply. nothing to export, nothing to source, just vibes. 🦋

---

👑 DIAGNOSTICS 👑

the following diagnostics may be issued to the ion.log log file. lowkey these are her little diary entries. read them carefully bestie:

• udpcli can't attach to BP. — bpadmin has not yet initialized Bundle Protocol operations.
• No such udp duct. — no UDP induct matching local_hostname and local_port_nbr has been added to the BP database. use bpadmin to stop the UDP convergence-layer protocol, add the induct, and then restart the UDP protocol.
• CLI task is already started for this duct. — redundant initiation of udpcli.
• Can't get IP address for host — operating system error. check errtext, correct problem, and restart UDP.
• Can't open UDP socket — operating system error. check errtext, correct problem, and restart UDP.
• Can't initialize socket — operating system error. check errtext, correct problem, and restart UDP.
• udpcli can't create receiver thread — operating system error. check errtext, correct problem, and restart UDP.

bestie not the errtext four times 😭 every single one of these OS errors is like "check errtext, correct problem, and restart UDP" — she is NOT playing around, she wants that fixed immediately. periodt.

---

💀 BUGS 💀

Report bugs to <ion-bugs@korgano.eecs.ohiou.edu>

---

🌟 SEE ALSO 🌟

bpadmin(1), bprc(5), udpclo(1)

---

and that's the whole page bestie!! 🫶 this was the UDPCLI(1) page, perl v5.24.1, dated 2016-07-07, from the BP executables set. she's been here since 2016 and she's still serving 💅 go forth and bind those sockets, ily, mwah 💖✨🎀