rc_avpair_free(3)

💖 rc_avpair_free(3) — the radcli girlies' cleanup era 💖

okay bestie, so this one lives in the Radius client library (radcli), and it's the manual page for rc_avpair_free. yes it's short. no it's not boring. it's the glow-up-and-go function of the whole value-pair friend group and we're gonna stan. ✨

---

🌸 NAME 🌸

rc_avpair_free — the "okay everyone, go home" function

(the original leaves the description blank, and honestly? she said nothing because she's too iconic to explain herself. but we know. we KNOW. 🫶)

---

🎀 SYNOPSIS 🎀

#include <radcli/radcli.h>

void rc_avpair_free(
    VALUE_PAIR  *pair
);

like… that's the whole vibe. one arg, no return value, no drama. she's a void girlie fr fr. 💅

---

🦋 DESCRIPTION 🦋

She frees all value_pairs in the list.

That's it. That's the whole description. Not me being lazy — the manpage literally says exactly that and we do not add facts that aren't there. But think about it: you hand her a linked list, she lets the whole thing go. she's the Marie Kondo of VALUE_PAIRs. if it doesn't spark joy in your heap, it's getting freed. 😭🔥

---

👑 PARAMETERS 👑

• pair — a pointer to a VALUE_PAIR structure. just a lil pointer, bestie. she's pointing at the top of your list and the cleanup ripples all the way down. no cap.

---

🌈 STRUCTURES 🌈

🚨 okay so this is the important part, listen up 🚨

Avoid using this structure directly. Use the rc_avpair_get_ functions. like, the manpage says it in plain english. she's telling you to stay in your lane and go through the getter functions. periodt. 🙈

but also — for the record, here's what she looks like, because iykyk and you deserve to see her:

struct rc_value_pair {
  char                   name[RC_NAME_LENGTH+1];      // attribute name if known.
  uint64_t               attribute; // attribute numeric value of type rc_attr_id including vendor; use VENDOR() and ATTRID() to separate.
  rc_attr_type           type;      // attribute type.
  uint32_t               lvalue;    // attribute value if type is PW_TYPE_INTEGER, PW_TYPE_DATE or PW_TYPE_IPADDR.
  char                   strvalue[AUTH_STRING_LEN+1];  // contains attribute value in other cases.
  struct rc_value_pair  *next;
  char                   pad[32];       // unused pad
};

look at her. name got a whole RC_NAME_LENGTH+1 situation going on. attribute is a uint64_t carrying the rc_attr_id including the vendor, and you're supposed to use VENDOR() and ATTRID() to split those apart — iconic division of labour. type is the attribute type. lvalue is where the value chills when the type is PW_TYPE_INTEGER, PW_TYPE_DATE or PW_TYPE_IPADDR. strvalue is AUTH_STRING_LEN+1 wide and holds the attribute value in all the other cases. there's a next pointer for the linked-list behavior, and pad[32] is literally labelled unused pad because she contains multitudes (and padding). 💀

and again, for the people in the back: don't touch her directly. use the rc_avpair_get_ functions. 💜

---

⭐ SEE ALSO ⭐

the whole bestie group chat, in alphabetical order because she's organized like that:

radcli.h(3), rc_aaa(3), rc_aaa_ctx(3), rc_aaa_ctx_free(3), rc_aaa_ctx_get_secret(3), rc_aaa_ctx_get_vector(3), rc_aaa_ctx_server(3), rc_acct(3), rc_acct_proxy(3), rc_add_config(3), rc_apply_config(3), rc_auth(3), rc_auth_proxy(3), rc_avpair_add(3), rc_avpair_assign(3), rc_avpair_copy(3), rc_avpair_free(3), rc_avpair_gen(3), rc_avpair_get(3), rc_avpair_get_attr(3), rc_avpair_get_in6(3), rc_avpair_get_raw(3), rc_avpair_get_uint32(3), rc_avpair_insert(3), rc_avpair_log(3), rc_avpair_new(3), rc_avpair_next(3), rc_avpair_parse(3), rc_avpair_remove(3), rc_avpair_tostr(3), rc_buildreq(3), rc_check(3), rc_check_tls(3), rc_conf_int(3), rc_conf_srv(3), rc_conf_str(3), rc_config_free(3), rc_config_init(3), rc_destroy(3), rc_dict_addattr(3), rc_dict_addval(3), rc_dict_addvend(3), rc_dict_findattr(3), rc_dict_findval(3), rc_dict_findvend(3), rc_dict_free(3), rc_dict_getattr(3), rc_dict_getval(3), rc_dict_getvend(3), rc_find_server_addr(3), rc_get_socket_type(3), rc_get_srcaddr(3), rc_getport(3), rc_mksid(3), rc_new(3), rc_openlog(3), rc_own_hostname(3), rc_read_config(3), rc_read_dictionary(3), rc_read_dictionary_from_buffer(3), rc_send_server(3), rc_setdebug(3), rc_test_config(3), rc_tls_fd(3)

(yes, rc_avpair_free(3) is listed in her own SEE ALSO. she said "and also me." main character energy. 💅)

---

and that's the page!! mwah. 😘

sign-off time: this lil masterpiece is brought to you by radcli, dated 2023-01-29, and the original footer called her rc_avpair_free(3). so like… go free your value pairs, bestie. she's waiting. 🦋✨💖