libssh2_session_free(3)

💖 libssh2_session_free — bestie, time to clean up 💖

okay so this is a page from the libssh2 manual, and it's all about libssh2_session_free(3) — the lil cleanup queen of the session world. she frees resources. she says goodbye. she slays. 🌸

✨ NAME ✨

libssh2_session_free — frees resources associated with a session instance 🧚

🌈 SYNOPSIS 🌈

#include <libssh2.h>

int
libssh2_session_free(LIBSSH2_SESSION *session);

like, that's the whole vibe. one include, one function, one LIBSSH2_SESSION * pointer. periodt. 💅

🦋 DESCRIPTION 🦋

okay so listen. libssh2_session_free frees all resources associated with a session instance. all of them. every last one. it's giving "spring cleaning but for memory" 🎀

you typically call this one after libssh2_session_disconnect_ex(3) — like, disconnect first, then free. that's the order, bestie, don't skip steps. 🙈

💀 RETURN VALUE 💀

• 0 — success, we ate, no crumbs ✨
• negative — failure, not the vibe 😭

and here's the part that trips people up: it returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. and yeah, LIBSSH2_ERROR_EAGAIN is a negative number, but it's not really a failure per se — it's more like "girl, not right now, try again later" 🫶 don't panic, don't treat it like an error, just come back to it.

👑 SEE ALSO 👑

• libssh2_session_init_ex(3)
• libssh2_session_disconnect_ex(3)

go read those too, iykyk 💜

this page is from libssh2 0.15, dated 1 Jun 2007 — yeah she's an elder icon but she still hits, no cap. mwah, bye bestie! 💋🌸💖