libssh2_session_get_read_timeout(3)

💖 libssh2_session_get_read_timeout(3) — the libssh2 glow-up 💖

okay bestie, sit down, hydrate, because we're talking about libssh2_session_get_read_timeout — a tiny little function from the libssh2 manual that is literally just here to tell you how patient your SSH packets are being. she's small. she's simple. she ate. 🎀

✨ NAME ✨

libssh2_session_get_read_timeout — get the timeout for packet read functions 🦋

🌸 SYNOPSIS 🌸

#include <libssh2.h>

long
libssh2_session_get_read_timeout(LIBSSH2_SESSION *session);

💅 DESCRIPTION 💅

So like, this one returns the timeout — in seconds — for how long the ssh2 packet receive function calls are allowed to just... wait. sitting there. vibing. 🫶

And if that waiting goes on too long, they clock it as an error and hand you back LIBSSH2_ERROR_TIMEOUT. no cap. that's the whole deal.

And by default? the timeout is 60 seconds. sixty. a whole minute. that's the factory setting, periodt. ⏳

👑 RETURN VALUE 👑

She gives you the value of the timeout setting. that's it. that's the return. iconic behaviour, honestly. ✨

🌈 AVAILABILITY 🌈

Added in 1.10.1. so if you're on something older than that, sorry bestie, this function is not in the group chat yet. 😭

🎀 SEE ALSO 🎀

• libssh2_session_set_read_timeout(3) — her sister. the one who actually changes the number. go say hi. 💜

fr fr, if you're out here wondering why your reads keep timing out, it's giving 60 seconds, and now you know where that number lives. 🍓

signing off from the libssh2 manual, dated 13 Jan 202 (yes the year got cut off mid-sentence, the footer said what it said, and I respect that 🙈) — stay patient, bestie, but not more patient than your timeout 💖🧚‍♀️