KHTML_OPEN(3)

πŸ“¦ version 1.0.1, in alpine 3.24

✨ NAME ✨

okay so bestie, this is KHTML_OPEN(3) β€” the page for khtml_open, which opens a kcgihtml context. yes, that's the whole name section, short and iconic πŸŽ€.

πŸ“š LIBRARY πŸ“š

library libkcgihtml β€” that's the C library we're in, bestie 🫢.

🧾 SYNOPSIS 🧾

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

enum kcgi_err
khtml_open(struct khtmlreq *req, struct kreq *r, int opts);

πŸ’– DESCRIPTION πŸ’–

okay so khtml_open() zeroes and initialises a brand-new context req using the underlying kcgi(3) context r β€” and r has to be allocated with khttp_parse(3) or khttp_fcgi_parse(3), no cap 🧚.

It should only be called after khttp_body(3). like, that's the vibe check: body started, then open the HTML context.

If opts is set to KHTML_PRETTY, the output is lightly β€œpretty-printed” with newlines and indentation spaces ✨. by default, output is all on one line (cramped but valid, bestie πŸ’…).

🚨 WARNING: if kcgi_writer_disable(3) has been called, the process will be killed with an uncatchable signal. not a drill, not a cute glitch β€” literally uncatchable πŸ’€.

πŸŽ€ RETURN VALUES πŸŽ€

Returns an enum kcgi_err indicating the error state. here's the whole squad:

  • KCGI_OK β€” Success (not an error). πŸŽ‰
  • 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 parse loop reentered. 🫠
  • KCGI_FORM β€” The connection is still expecting headers with khttp_head(3). 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 parse loop reentered. πŸ™ˆ
  • KCGI_SYSTEM β€” Internal system error writing to the output stream. πŸ’₯

🌸 EXAMPLES 🌸

The following outputs a simple HTML page. It assumes r is a struct kreq pointer. For brevity, it does not do any error checking.

khttp_head(r, kresps[KRESP_STATUS],
  "%s", khttps[KHTTP_200]);
khttp_head(r, kresps[KRESP_CONTENT_TYPE],
  "%s", kmimetypes[KMIME_TEXT_HTML]);
khttp_body(r);
khtml_open(&req, r, 0);
khtml_elem(&req, KELEM_DOCTYPE);
khtml_elem(&req, KELEM_HTML);
khtml_elem(&req, KELEM_BODY);
khtml_puts(&req, "Hello, world");
khtml_close(&req);

πŸ‘€ SEE ALSO πŸ‘€

πŸ“ STANDARDS πŸ“

The referenced HTML5 standard is HTML5.2: https://www.w3.org/TR/html52. periodt 🌈.

🫢 AUTHORS 🫢

Written by Kristaps Dzonsons <kristaps@bsd.lv>. iconic πŸ‘‘.


this page is from Debian (source/version), stamped $Mdocdate$ (date), and it's KHTML_OPEN(3) β€” mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from
  • alpine 3.24: kcgi-doc 1.0.1-r0 Β· ISC
  • πŸ’– girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms