NAME

kjson_string_write — put content data for kcgijson

LIBRARY

library “libkcgijson”

SYNOPSIS

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

enum kcgi_err
kjson_string_write(const char *buf, size_t sz, void *arg);

DESCRIPTION

Write binary data buf of length sz into a string scope opened with kjson_string_open(3) or kjson_stringp_open(3) to a context arg, a struct kjsonreq initialised with khtml_open(3) and passed as an opaque pointer. If buf is NULL or sz is zero, do nothing and return KCGI_OK.

All characters are JSON escaped so that content cannot prematurely end its context.

RETURN VALUES

Returns an enum kcgi_err indicating the error state.

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.
KCGI_WRITER: The incorrect form was used for the current scope, for example, an array-type write within an object.

EXAMPLES

The following outputs a simple JSON document. 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_APP_JSON]);
khttp_body(r);
kjson_open(&req, r);
kjson_string_open(&req);
kjson_string_write("hello", 5, &req);
kjson_close(&req);

AUTHORS

Written by Kristaps Dzonsons <kristaps@bsd.lv>.