UMAD_INIT(3)

๐Ÿ’… UMAD_INIT(3) โ€” bestie, itโ€™s giving OpenIB Programmerโ€™s Manual ๐Ÿ’…

okay so welcome to the UMAD_INIT(3) page from the OpenIB Programmerโ€™s Manual. this one is short, iconic, and honestly a little chaotic in its simplicity. letโ€™s get into it. ๐Ÿซถ


๐ŸŒธ NAME ๐ŸŒธ

umad_init, umad_done โ€” perform library initialization and finalization


โœจ SYNOPSIS โœจ

#include <infiniband/umad.h>

int umad_init(void);

int umad_done(void);

๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

umad_init() and umad_done() do nothing. thatโ€™s the whole thing. no secret side quest, no hidden behavior โ€” they literally do nothing. ๐Ÿ’€โœจ


โญ RETURN VALUE โญ

Always 0. every time. slay. ๐ŸŽ€


๐ŸŽ€ COMPATIBILITY ๐ŸŽ€

okay so context, bestie: versions prior to release 18 of the library require umad_init() to be called prior to using any other library functions. old versions could return a failure code of -1 from umad_init(). ๐Ÿ˜ญ

for compatibility, applications should continue to call umad_init(), and check the return code, prior to calling other umad_ functions. if umad_init() returns an error, then no further use of the umad library should be attempted. ๐Ÿšจ this is the โ€œdo not keep poking the library after it says noโ€ rule, iykyk.


๐Ÿ‘‘ AUTHORS ๐Ÿ‘‘

  • Dotan Barak <dotanb@mellanox.co.il>
  • Hal Rosenstock <halr@voltaire.com>

signed, sealed, and serving source/version energy: OpenIB โ€” May 21, 2007 ๐Ÿ’–๐Ÿซถ๐Ÿ’…

๐Ÿ“ฆ where this page comes from