libssh2_channel_close(3)

💖 libssh2_channel_close(3) — the libssh2 girlies' guide 💖

okay bestie, we're doing the libssh2 manual page for libssh2_channel_close, and honestly? it's giving "saying bye to your situationship but they still got your location" energy. let's get into it 🫶

✨ NAME ✨

libssh2_channel_close — close a channel 💅

🌸 SYNOPSIS 🌸

#include <libssh2.h>

int
libssh2_channel_close(LIBSSH2_CHANNEL *channel);

like yes, that's the whole thing, she's simple, she's iconic ✨

🦋 DESCRIPTION 🦋

• channel — the active channel stream you want to set to closed status. that's your main character, okay?

So bestie, what this does is close an active data channel. In practice? You're literally sending an SSH_MSG_CLOSE packet over to the remote host, and that packet is basically you going "hey, no further data is coming from me, periodt." 🎀

BUT. And this is the part people miss — the remote host may still send data back until it sends its own close message in response. So it's not a two-way door slam, it's more like you walking out and them still texting. 🙈

If you actually want to wait for the remote end to close its connection too, you gotta follow this command up with libssh2_channel_wait_closed(3). that's the "okay are you done? are we done? hello?" step. no cap.

⭐ RETURN VALUE ⭐

Returns 0 on success, or a negative number on failure. 💀

It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. And listen — even though LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. it's more like "not right now bestie, try again later" energy. don't panic, she's just busy. 🧚

💜 ERRORS 💜

• LIBSSH2_ERROR_SOCKET_SEND — Unable to send data on socket. that's the "your message didn't send, it's sitting there with the little loading spinner forever" moment. 😭

🌈 SEE ALSO 🌈

• libssh2_channel_open_ex(3) — because every close needs its open, yin and yang, the circle of life, you get it 🔥

this page comes to you from the libssh2 manual, version libssh2 0.15, dated 1 Jun 2007 — yeah she's vintage, she's an elder, and she still ate. 👑 mwah, go close some channels responsibly, ily 💖✨