Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
KJSON_OBJ_CLOSE(3)	    Library Functions Manual	    KJSON_OBJ_CLOSE(3)

NAME
       kjson_obj_close -- open object 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_obj_close(struct kjsonreq *req);

DESCRIPTION
       Closes	 an   object   scope   created	 with	kjson_obj_open(3)   or
       kjson_objp_open(3) in a context req initialised with khtml_open(3).  It
       is an error to close a non-object scope.

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  connec-
	    tions,   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).  In-
	    dicates 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	current	scope is not 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_obj_open(&req);
	     kjson_objp_open(&req, "foo");
	     kjson_putstringp(&req, "data", "shbar");
	     kjson_obj_close(&req); /* foo */
	     kjson_objp_open(&req, "bar");
	     kjson_putstringp(&req, "data", "xyzzy");
	     kjson_obj_close(&req); /* bar */
	     kjson_close(&req);

SEE ALSO
       kcgijson(3)

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

FreeBSD	Ports 14.quarterly	  $Mdocdate$		    KJSON_OBJ_CLOSE(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=kjson_obj_close&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help