NAME

kjson_string_open, kjson_stringp_open — open string scope 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_open(struct kjsonreq *req);

enum kcgi_err
kjson_stringp_open(struct kjsonreq *req, const char *name);

DESCRIPTION

Open an string scope in a context req initialised with khtml_open(3). Scopes are closed with kjson_string_close(3) or kjson_close(3). String scopes are open strings that may be filled in with further kjson_string_puts(3) and family functions.

The kjson_string_open() form is for array scopes, while kjson_stringp_open() for objects.

Passing a NULL value to name for kjson_stringp_open(), is equivalent to calling kjson_string_open().

RETURN VALUES

Returns an enum kcgi_err indicating the error state.

KCGI_OK

Success (not an error).

KCGI_ENOMEM

Internal memory allocation failure, including reaching the maximum number of possible JSON scopes.

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_puts(&req, "Hello, ");
kjson_string_puts(&req, "world.");
kjson_close(&req);

SEE ALSO

kcgijson(3)

AUTHORS

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