NODEUPDOWN_GET_UP_NODES_LIST(3)

✨ NODEUPDOWN_GET_UP_NODES_LIST ✨

okay bestie, welcome to nodeupdown_get_up_nodes_list(3), nodeupdown_get_down_nodes_list(3) — part of the LIBNODEUPDOWN manual, third section, the library calls, you know the vibe 💖

---

🌸 NAME 🌸

nodeupdown_get_up_nodes_list, nodeupdown_get_down_nodes_list — bestie, these two literally just get you the up nodes or the down nodes. that's it. that's the whole job. 🦋

---

🎀 SYNOPSIS 🎀

#include <nodeupdown.h>

int nodeupdown_get_up_nodes_list(nodeupdown_t handle, char **list, int
len);

int nodeupdown_get_down_nodes_list(nodeupdown_t handle, char **list, int
len);

---

💅 DESCRIPTION 💅

so nodeupdown_get_up_nodes_list() goes and fetches you a list of all the nodes that are up, and it drops each node name into the list that list points at. and len? that's you telling it how many nodes you can actually fit in list. don't lie to it, it will find out. 😭

nodeupdown_get_down_nodes_list() is the exact same thing, no cap — identical in every way — except it hands you the down nodes instead. same energy, opposite outcome. 🫶

okay so real talk: to avoid passing in a list that isn't big enough to hold all the up or down nodes, use nodeupdown_nodelist_create(3) to make your list. it's guaranteed to be large enough for every single node. save yourself the heartbreak. 💀

---

⭐ RETURN VALUES ⭐

slay, here's the deal:

• on success, it returns the number of nodes it copied into list 👑
• on error, it returns -1, and an error code gets stashed in handle

you can grab that error code with nodeupdown_errnum(3), and get a lil description of what went wrong with nodeupdown_strerror(3). the error codes themselves are all defined in nodeupdown.h, iykyk. 🌈

---

💖 ERRORS 💖

here's every single one, bestie, no skipping:

• NODEUPDOWN_ERR_NULLHANDLE — the handle parameter is NULL. you gotta make that nodeupdown handle with nodeupdown_handle_create(3) first. it's giving "forgot the main character." 🎀
• NODEUPDOWN_ERR_NOTLOADED — nodeupdown_load_data(3) has not been called, and no data has been retrieved. no data, no list, periodt. 💅
• NODEUPDOWN_ERR_PARAMETERS — an incorrect parameter got passed in. wrong vibe, rejected. 🙈
• NODEUPDOWN_ERR_NULLPTR — there's a null pointer hanging out in the list you passed in. 😭
• NODEUPDOWN_ERR_OVERFLOW — the list that list points to is not large enough to store all the nodes. it overflowed. it's over. 💀
• NODEUPDOWN_ERR_OUTMEM — malloc(3) failed internally. the memory said no. 🔥
• NODEUPDOWN_ERR_CLUSTERLIST_MODULE — internal error with the clusterlist module. not your fault, lowkey. 🦋
• NODEUPDOWN_ERR_HOSTLIST — the Hostlist API has failed internally. it's giving chaos. 🌸
• NODEUPDOWN_ERR_MAGIC — handle has an incorrect magic number. either handle doesn't point to a nodeupdown handle at all, or it's already been destroyed by nodeupdown_handle_destroy(3). the magic is gone, bestie. ✨

---

🧚 FILES 🧚

• /usr/include/nodeupdown.h

---

🌈 SEE ALSO 🌈

libnodeupdown(3), nodeupdown_handle_create(3), nodeupdown_load_data(3), nodeupdown_get_up_nodes_string (3), nodeupdown_get_down_nodes_string (3), nodeupdown_errnum(3), nodeupdown_strerror(3)

---

and that's the whole page, bestie, you ate it 💅 this iconic lil number comes to you from LLNL, dated August 2003 — yeah, it's vintage, and it still slays. bye bye, go read some more manpages 🫶✨