libssh2_keepalive_send(3)

💖 libssh2_keepalive_send(3) 💖

okay bestie, this one lives in the libssh2 manual, and it's the little heartbeat-check function that keeps your SSH connection from ghosting you. yes, that's a thing. it's giving "u up?" but for sockets. 🦋

✨ NAME ✨

libssh2_keepalive_send — short function description

ngl the original manpage literally just says "short function description" and honestly? iconic of them. anyway. sending keepalives. that's the vibe. 💅

🌸 SYNOPSIS 🌸

#include <libssh2.h>

int
libssh2_keepalive_send(LIBSSH2_SESSION *session,
                       int *seconds_to_next);

🎀 DESCRIPTION 🎀

Send a keepalive message if needed. that "if needed" is doing a lot of heavy lifting, so pay attention bestie.

seconds_to_next is a pointer, and after the call it'll tell you how many seconds you can sleep after this call before you need to call it again. so it's basically the function tapping you on the shoulder like "hey. hey. set a timer. i'll need you again in this many seconds." ⏰✨

🔥 RETURN VALUE 🔥

Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors. so if it's not 0, something went sideways on the socket send and you should go check on that. 💀

👑 AVAILABILITY 👑

Added in libssh2 1.2.5 — a true vintage queen, been around since forever fr fr. 🫶

🌈 SEE ALSO 🌈

• libssh2_keepalive_config(3) — go read this one too, they're a matched set, iykyk 💜

that's the whole page, bestie, go keep those connections alive 💖✨

this was brought to you by the libssh2 manual, 13 Apr 2011 — yes it's an oldie but she still slays. mwah. 🎀