kjson_close.3

NAME

kjson_close — close kcgijson context

LIBRARY

library “libkcgijson”

SYNOPSIS

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

enum kcgi_err
kjson_close(struct kjsonreq *req);

DESCRIPTION

Closes req, initialised with kjson_open(3). All scopes opened with kjson_obj_open(3), kjson_objp_open(3), kjson_array_open(3), kjson_arrayp_open(3), kjson_string_open(3), and kjson_stringp_open(3) are automatically closed. After this, req may no longer be used.

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.

EXAMPLES

The following outputs a simple JSON 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_APP_JSON]);
khttp_body(r);
kjson_open(&req, r);
kjson_obj_open(&req);
kjson_putstringp(&req, "foo", "bar");
kjson_close(&req);

AUTHORS

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