libssh2_channel_eof(3)

✨ NAME ✨

okay so this is the libssh2_channel_eof(3) page, bestie, and the main character is libssh2_channel_eof — check a channel's EOF status. that's the whole plot. no cap. 💅

📜 SYNOPSIS 📜

#include <libssh2.h>

int
libssh2_channel_eof(LIBSSH2_CHANNEL *channel);

🌸 DESCRIPTION 🌸

so there's exactly one argument here, and she's important:

• channel — active channel stream to set closed status on.

what does the function actually do? Check if the remote host has sent an EOF status for the selected stream. so you're basically asking the remote side, "bestie, are you done sending on this stream or what?" 🦋

🫶 RETURN VALUE 🫶

here's the tea:

• Returns 1 if the remote host has sent EOF, otherwise 0.
• Negative on failure. 😭

so like, 1 means remote said bye, 0 means not yet, and negative means something went wrong. periodt.

👀 SEE ALSO 👀

• libssh2_channel_close(3)

xoxo, this page is from libssh2 0.15, dated 1 Jun 2007, and it's literally libssh2_channel_eof(3). slay. 💖