libssh2_channel_window_read_ex(3)

💖 libssh2_channel_window_read_ex(3) — the libssh2 manual, bestie edition 💖

okay so we're peeking at the read window today, and honestly? it's giving very important. this one lives in the libssh2 manual, and it's about checking how much room the remote end still has to send you stuff before the window gets full. 🪟✨

✨ NAME ✨

libssh2_channel_window_read_ex — Check the status of the read window 👑

🌸 SYNOPSIS 🌸

#include <libssh2.h>

unsigned long
libssh2_channel_window_read_ex(LIBSSH2_CHANNEL *channel,
                               unsigned long *read_avail,
                               unsigned long *window_size_initial)

🦋 DESCRIPTION 🦋

So like, this function checks the status of the read window. it hands you back the number of bytes the remote end may send without overflowing the window limit 💅

and there's two optional lil out-params, bestie, both pointers:

• if you pass read_avail, it gets populated with the number of bytes actually available to be read 👀
• if you pass window_size_initial, it gets populated with the window_size_initial as defined by the channel_open request 🎀

pass NULL for whichever one you don't care about, no pressure. 🫶

⭐ RETURN VALUE ⭐

the number of bytes which the remote end may send without overflowing the window limit. that's the whole vibe. 🔥

💀 ERRORS 💀

(no cap, this section is literally empty in the original. nothing to report. iconic of it honestly.) 🙈

🌈 SEE ALSO 🌈

• libssh2_channel_receive_window_adjust(3)
• libssh2_channel_window_write_ex(3)

and that's the whole page, bestie!! this lil legend comes to you from libssh2 0.15, dated 1 Jun 2007 — yeah she's an elder but she still ate 💅✨ go read your window sizes, mwah 🎀🦋💖