KXML_OPEN(3)

💅 KXML_OPEN(3) — like, the kcgixml context opener, bestie

okay so this one lives in the Library Functions Manual and it's from the libkcgixml library ✨ (yes, that's the whole library name, no cap).

---

🌸 NAME 🌸

kxml_open — open a kcgixml context 🫶

---

🎀 LIBRARY 🎀

library “libkcgixml”

---

✨ SYNOPSIS ✨

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

enum kcgi_err
kxml_open(struct kxmlreq *xml, struct kreq *req,
    const char *const *elems, size_t elemsz);

---

💖 DESCRIPTION 💖

So what this does is it zeroes and initialises a brand-new context req, sitting on top of the underlying kcgi(3) context r — and r has to have been allocated with khttp_parse(3) or khttp_fcgi_parse(3), no exceptions bestie 🔥

Lowkey important: you should only call this after khttp_body(3). Like, that's the vibe check and it has to pass.

The context gets initialised with elemsz possible elements, and their names are elems. And here's the thing — it's your job (the caller's responsibility, periodt 💅) to make sure those are actually valid XML element names. This function is not gonna hold your hand on that one.

Also 🚨 if kcgi_writer_disable(3) has been called, the process will be killed with an uncatchable signal. Not a vibe. Very much not a vibe. 💀

---

🦋 RETURN VALUES 🦋

It returns an enum kcgi_err showing the error state, and here's the whole menu:

• KCGI_OK — success! not an error! we love to see it 👑
• KCGI_ENOMEM — internal memory allocation failure 😭
• KCGI_HUP — the output connection got terminated. For FastCGI connections, you should release the current connection with khttp_free(3) and reenter the parse loop 🔁
• KCGI_FORM — the connection is still expecting headers with khttp_head(3). This means khttp_body(3) either didn't return with success or just straight-up wasn't invoked 🙈. For FastCGI connections, release the current connection with khttp_free(3) and reenter the parse loop, same drill.
• KCGI_SYSTEM — internal system error while writing to the output stream 💀

---

🌈 EXAMPLES 🌈

The following outputs a simple XML page 🎉 It assumes r is a struct kreq pointer. And for brevity — because we're keeping it cute and short — it does no error checking at all (iconic of it, honestly):

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)

---

💜 AUTHORS 💜

Written by Kristaps Dzonsons <kristaps@bsd.lv> — thank you king 🫶

---

okay that's the whole page, mwah 💋 this thing is Debian-flavoured, version $Mdocdate$, and it goes by KXML_OPEN(3) if you ever need to find it again. bye bestie, go open some contexts ✨🎀