KXML_CLOSE(3)

✨ NAME ✨

kxml_close — close kcgixml context. Hi bestie, welcome to the kxml_close(3) page! This is the function that wraps up your kcgixml context and says bye. 🎀

🦋 LIBRARY 🦋

This one lives in the library libkcgixml, and yes it's iconic for that. 💅

🌸 SYNOPSIS 🌸

#include <sys/types.h>
#include <stdarg.h>
#include <stdint.h>
#include <kcgi.h>
#include <kcgixml.h>

enum kcgi_err
kxml_close(struct kxmlreq *req);

💖 DESCRIPTION 💖

Okay so kxml_close closes req — the context you initialised with kxml_open(3). Every scope you opened with kxml_push(3) and kxml_pushattrs(3) gets automatically closed too, no manual cleanup era needed. ✨

⚠️ After this, req may no longer be used. Like, do not touch it, do not text it back, do not reuse it. Periodt. 💀

🔥 RETURN VALUES 🔥

It returns an enum kcgi_err that tells you the error state. Here's the full lineup:

• KCGI_OK — Success, aka not an error. Slay. 🎉
• KCGI_ENOMEM — Internal memory allocation failure. 😭
• KCGI_HUP — The output connection has been terminated. For FastCGI connections, the current connection should be released with khttp_free(3) and the parse loop reentered. 🫶
• KCGI_FORM — The connection is still expecting headers with khttp_head(3). This indicates that khttp_body(3) did not return with success or was not invoked. For FastCGI connections, the current connection should be released with khttp_free(3) and the parse loop reentered. 🌀
• KCGI_SYSTEM — Internal system error writing to the output stream. Big yikes. 💀

🌈 EXAMPLES 🌈

The following outputs a simple XML page. It assumes r is a struct kreq pointer. For brevity, it does not do any error checking. Copy-paste responsibly, bestie. 🍓

const char *const elems[] =
  { "foo", "bar", "baz" };
khttp_head(r, kresps[KRESP_STATUS],
  "%s", khttps[KHTTP_200]);
khttp_head(r, kresps[KRESP_CONTENT_TYPE],
  "%s", kmimetypes[KMIME_TEXT_XML]);
khttp_body(r);
kxml_open(&req, r, elems, 3);
kxml_push(&req, 0); /* foo */
kxml_puts(&req, "Hello, world");
kxml_close(&req);

💜 SEE ALSO 💜

• kcgixml(3) — the whole family, go explore. 🌈

👑 AUTHORS 👑

Written by Kristaps Dzonsons <kristaps@bsd.lv>. Respect the icon. 👑

---

🎀 That's the whole KXML_CLOSE(3) page — Debian source/version, date-stamped $Mdocdate$. Bye bestie, go close those contexts! 🎀