WSLAY_EVENT_QUEUE_CLOSE(3)

💖 WSLAY_EVENT_QUEUE_CLOSE 💖

okay bestie, welcome to wslay(3) — specifically the WSLAY_EVENT_QUEUE_CLOSE page. this one's short, sweet, and honestly kind of iconic. let's get into it ✨

---

🌸 NAME 🌸

wslay_event_queue_close — queue a close control frame 🎀

---

🦋 SYNOPSIS 🦋

#include <wslay/wslay.h>

int wslay_event_queue_close(wslay_event_context_ptr ctx, uint16_t
status_code, const uint8_t *reason, size_t reason_length)

like. look at her. four args, one return value, zero drama. 💅

---

✨ DESCRIPTION ✨

so wslay_event_queue_close() queues a close control frame. that's the whole vibe fr fr.

real talk though — this function is provided just for convenience. it's giving "you could do this yourself, but why would you". because here's the thing: wslay_event_queue_msg() can queue a close control frame as well. so if you're already deep in that function's DMs, you're covered. wslay_event_queue_close() is just the easy button. 🫶

now let's talk about the args, because they matter:

• status_code — this is the status code of the close control frame. it's a uint16_t, so it's a cute little number.
• reason — the close reason, encoded in UTF-8. yes, it has to be UTF-8, don't come at me with your latin-1 nonsense 🙈
• reason_length — the length of reason in bytes. not characters, bestie. bytes.

⚠️ and here's the one that will get you: reason_length must be less than 123 bytes. not less than or equal to. less than. 123 is the ceiling and you are not touching it. 💀

there's also a lil special case, and it's lowkey my fave:

if status_code is 0, then reason and reason_length are not used at all — they get ignored, no cap — and a close control frame with a zero-length payload will be queued instead. so you can just pass 0 and dip. 🌈

and now the part everyone forgets:

this function just queues a message. it does not send it. 🚨

nothing goes out on the wire from calling this. you have to call wslay_event_send() to actually send these queued messages. so don't queue your close frame and then sit there wondering why nothing happened, because that's on you, not on her. 😭

---

🔥 RETURN VALUE 🔥

wslay_event_queue_close() returns 0 if it succeeds. slay. ✅

or it returns one of these negative error codes, and honestly, mood:

• WSLAY_ERR_NO_MORE_MSG — could not queue the given message. one of the possible reasons is that a close control frame has already been queued/sent, and no further queueing of a message is not allowed. so basically: you already closed the door, why are you trying to close it again 🚪🔒
• WSLAY_ERR_INVALID_ARGUMENT — the given message is invalid. something about your args is not passing the vibe check.
• WSLAY_ERR_NOMEM — out of memory. 💀 the classic.

---

💜 SEE ALSO 💜

go read these too, they're in the group chat:

• wslay_event_queue_msg()
• wslay_event_queue_fragmented_msg()

---

👑 AUTHOR 👑

Tatsuhiro Tsujikawa — the icon, the legend, the moment. 🌟

---

🎀 COPYRIGHT 🎀

2024, 2015, Tatsuhiro Tsujikawa

---

and that's the page, bestie!! 🦋 this was @PACKAGE_VERSION@, dated Apr 22, 2024, living in section 3 of the wslay manual. queue responsibly, keep your reason_length under 123 bytes, and always remember to actually call wslay_event_send(). mwah 💖✨