libssh2_poll(3)

✨ NAME ✨

okay so bestie, we're looking at libssh2_poll(3) from the libssh2 manual — and it's all about poll for activity on a socket, channel or listener. 💖

🫶 SYNOPSIS 🫶

#include <libssh2.h>

int
libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout);

💅 DESCRIPTION 💅

🚨 Deprecated alert, bestie! This function is deprecated. The original page says "Do note use." — like, for real, do not use it. We encourage users to instead use the poll(3) or select(3) functions to check for socket activity or when specific sockets are ready to get received from or send to. 💀

So what did it do? It polls for activity on a socket, channel, listener, or any combination of these three types. The calling semantics for this function generally match poll(2), however the structure of fds is somewhat more complex in order to accommodate the disparate datatypes, POLLFD constants have been namespaced to avoid platform discrepancies, and revents has additional values defined. ✨

🌈 RETURN VALUE 🌈

Number of fds with interesting events. 💅

🦋 SEE ALSO 🦋

• libssh2_poll_channel_read(3)

mwah 💋 this lil page is from libssh2 0.15, dated 14 Dec 2006, and its header/footer name is libssh2_poll(3) — periodt. 🎀