libssh2_channe..._extended_data(3)

💖 libssh2_channel_handle_extended_data — setting the vibe for extended data 💖

okay bestie, welcome to libssh2's manual, page libssh2_channel_handle_extended_data. yes the title is long, no we are not shortening it, it's giving ✨ main character ✨ energy and we respect it.

This one sets the extended data handling mode on a channel. iykyk. 🎀

✨ SYNOPSIS ✨

#include <libssh2.h>

void
libssh2_channel_handle_extended_data(LIBSSH2_CHANNEL *channel,
                                     int ignore_mode);

🌸 DESCRIPTION 🌸

okay so FIRST of all, big news:

🚨 This function is DEPRECATED in 1.1.0. 🚨 Use the libssh2_channel_handle_extended_data2(3) function instead! not me telling you to move on, but like… move on bestie 💅

Here's the tea on the two args:

• channel — the Active channel stream you wanna change extended data handling on. that's the one. 👑
• ignore_mode — you pick ONE of the three LIBSSH2_CHANNEL_EXTENDED_DATA_* Constants. choose wisely, this is your moment:
  • LIBSSH2_CHANNEL_EXTENDED_DATA_NORMAL — Queue extended data for eventual reading. it just sits there, patiently, waiting for its turn 🫶
  • LIBSSH2_CHANNEL_EXTENDED_DATA_MERGE — Treat extended data and ordinary data the same. Merge all substreams such that calls to libssh2_channel_read(3) will pull from all substreams on a first-in/first-out basis. one big happy blended family, FIFO style 🌈
  • LIBSSH2_CHANNEL_EXTENDED_DATA_IGNORE — Discard all extended data as it arrives. literally not reading it, blocking it, ghosting it entirely 💀🙈

So like, what does this whole thing do? it changes how a channel deals with extended data packets. and by default? all extended data is queued until read by libssh2_channel_read_ex(3). that's the default behavior, no cap. ✨

🦋 RETURN VALUE 🦋

None.

that's it. that's the whole return value. it gives nothing and honestly? iconic. 💅

👑 SEE ALSO 👑

• libssh2_channel_handle_extended_data2(3)
• libssh2_channel_read_ex(3)

k bye bestie, go read the sequel ..._extended_data2 like the deprecation warning asked you to 🎀

this page came from libssh2, version 0.15, dated 1 Jun 2007 — and the manual name is libssh2, in case you were wondering where the header went. it's right here. in my heart. 💖