UMAD_CLASS_STR(3)

💖 UMAD_CLASS_STR(3) — the OpenIB Programmer's Manual, but make it cute 💖

okay bestie, so this is umad_class_str (that's the manual page name, it's giving "family of functions") and it's your little translator bestie for enums. like, you got a number, and you want a word? say less. 🦋

✨ NAME ✨

umad_*_str — a whole class of functions that return string representations of enums 💅

🌸 SYNOPSIS 🌸

#include <infiniband/umad_str.h>

const char * umad_class_str(uint8_t mgmt_class)
const char * umad_method_str(uint8_t mgmt_class, uint8_t method)
const char * umad_attribute_str(uint8_t mgmt_class, be16_t attr_id)

const char * umad_common_mad_status_str(be16_t status)
const char * umad_sa_mad_status_str(be16_t status)

🎀 DESCRIPTION 🎀

• const char * umad_class_str(uint8_t mgmt_class) — hands you the string value of a management class enum, fr fr. 🫶
• const char * umad_method_str(uint8_t mgmt_class, uint8_t method) — gives you the string value of the method, specifically for the mgmt_class you passed in. it's method behavior, tailored. ✨
• const char * umad_attribute_str(uint8_t mgmt_class, be16_t attr_id) — returns the string value of whatever attribute is chillin' in attr_id, based on the mgmt_class you specified. yes, the class matters here, it's a whole vibe check. 👑
• const char * umad_common_mad_status_str(be16_t status) — returns the string value for common MAD status values. the basics, the everyday icons. 💖
• const char * umad_sa_mad_status_str(be16_t status) — returns the string value for SA MAD status values. SA-specific, she's special. 💜

NOTE: Not all classes are supported. 😭 so like… don't come for her when your niche class gets nothing back. it's not her fault, it's literally in the manual.

⭐ RETURN VALUE ⭐

Returns a string representation of the fields you specified. that's it, that's the whole thing — strings, back to you, slay. 🌈

💫 AUTHOR 💫

Ira Weiny <weiny2@llnl.gov> — the icon, the legend, the main character who wrote this. 🙈

and that's the whole page bestie!! this came from the OpenIB crew, dated Feb 15, 2013, and it lives in the OpenIB manual section 3. go forth and stringify your enums, no cap. 💅✨🎀