libssh2_channe...window_adjust2(3)

✨ libssh2_channel_receive_window_adjust2 — adjust the channel window ✨

okay bestie, welcome to the libssh2 girlies' corner of the manual 💅 this one's all about libssh2_channel_receive_window_adjust2, and yes the page header is out here looking like libssh2_channe...window_adjust2(3) because apparently the title got too long for its own good. iconic behavior honestly. 🫶

🌸 NAME 🌸

libssh2_channel_receive_window_adjust2 — adjust the channel window

🦋 SYNOPSIS 🦋

#include <libssh2.h>

int
libssh2_channel_receive_window_adjust2(LIBSSH2_CHANNEL * channel,
                                       unsigned long adjustment,
                                       unsigned char force,
                                       unsigned int *window);

💖 DESCRIPTION 💖

so basically 💅 this function adjusts the receive window for a channel, and it does that by adjustment bytes. that's the whole vibe.

here's the tea tho 🍓 if the amount you're adjusting by is less than LIBSSH2_CHANNEL_MINADJUST and force is 0, then the adjustment amount gets queued up for a later packet instead of going out right now. not me being patient about it, but okay, we wait. 😌

also, this function stores the new size of the receive window — like, the size as understood by the remote end — into the variable that window points to. so you get the receipts back. 👑

💀 RETURN VALUE 💀

returns 0 on success, and a negative value on error. and if you're running in non-blocking mode, it'll hand you back LIBSSH2_ERROR_EAGAIN whenever it would otherwise block. so don't panic, it's just saying "not right now bestie". 😭

🙈 ERRORS 🙈

no specific errors listed here, that's just the whole section. moving on, we don't dwell. ✨

👑 AVAILABILITY 👑

added in libssh2 1.1, because the previous API had deficiencies. lowkey the glow-up era. 🔥

🌈 SEE ALSO 🌈

• libssh2_channel_window_read_ex(3)

okay that's the whole page, no cap 💜 this was written for libssh2 version 1.1, dated 26 Mar 2009, and the header on top of it all is libssh2_channe...window_adjust2(3) — periodt. 🎀✨