libssh2_session_init_ex(3)

✨ libssh2_session_init_ex — bestie's guide to starting an SSH session 💖

ok so this is page libssh2_session_init_ex(3) from the libssh2 manual, and it's literally the first thing you call. main character energy only.

🌸 SYNOPSIS 🌸

#include <libssh2.h>

LIBSSH2_SESSION *
libssh2_session_init_ex(LIBSSH2_ALLOC_FUNC((*myalloc)),
                        LIBSSH2_FREE_FUNC((*myfree)),
                        LIBSSH2_REALLOC_FUNC((*myrealloc)),
                        void *abstract);

LIBSSH2_SESSION *
libssh2_session_init(void);

two flavours, bestie: the fancy one with all the callbacks, and the chill one with zero args 🫶

💅 DESCRIPTION 💅

ok so the extended version takes four args, let's go one by one:

• myalloc — ur custom allocator function. go read the section on Callbacks for how to actually write an allocator callback. pass NULL and it just uses the default system allocator, no stress ✨
• myfree — ur custom de-allocator function. again, Callbacks section has the deets for implementing a deallocator callback. NULL here means default system deallocator, periodt.
• myrealloc — ur custom re-allocator function. yep, Callbacks section, reallocator callback, you know the drill. NULL = default system reallocator 🌸
• abstract — an arbitrary pointer to application specific callback data. this value gets passed to any callback function associated with the named session instance. it's giving "attach whatever u want to the session" 💫

so what does the whole thing actually do? it initializes an SSH session object, duh 💖 by default the system memory allocators (malloc(), free(), realloc()) handle every dynamically allocated memory block. but if u want alternate memory allocation functions, that's what the extended version of this API call is for — and/or u can attach optional application specific data to the session object. slay.

⚠️ important bestie: this method must be called first, before u configure session options or start up an SSH session with a remote server. like, it's the opening act. no skipping ahead. 🙈

🎀 RETURN VALUE 🎀

a pointer to a freshly allocated LIBSSH2_SESSION instance 💖 … or NULL if something went wrong 😭 (errors, bestie, errors).

🦋 SEE ALSO 🦋

• libssh2_session_free(3)
• libssh2_session_handshake(3)

and that's the whole vibe, bestie ✨ this was from libssh2 version 0.15, dated 1 Jun 2007 — yeah she's vintage but she still ate 💅👑 no cap, go init that session. 🎀🦋💜