Stream Output

Functions
JSONOut *	jsonOutBegin (StreamBuffer *sb, flags_t flags)
bool	jsonOut (JSONOut *jo, JSONParseEvent *ev)
void	jsonOutEnd (JSONOut **jo)

Detailed Description

Event-driven JSON output using parse events.

Function Documentation

jsonOut()

bool jsonOut	(	JSONOut *	jo,
		JSONParseEvent *	ev
	)

bool jsonOut(JSONOut *jo, JSONParseEvent *ev)

Writes a JSON element using a parse event.

Call this repeatedly with appropriate JSONParseEvent structures to build the JSON output. Events should be sent in a valid sequence (e.g., object keys must be followed by values).

Parameters

jo	JSON output context from jsonOutBegin()
ev	Parse event describing the element to output

Returns

true on success, false on error

jsonOutBegin()

JSONOut * jsonOutBegin	(	StreamBuffer *	sb,
		flags_t	flags
	)

JSONOut *jsonOutBegin(StreamBuffer *sb, flags_t flags)

Begins event-driven JSON output to a stream buffer.

Initializes a JSON output context that writes to the stream buffer in PUSH mode. After calling this, repeatedly call jsonOut() with JSONParseEvent structures to build the output, then call jsonOutEnd() to finalize.

Parameters

sb	Stream buffer to write to
flags	Output formatting flags from JSON_OUT_FLAGS

Returns

JSON output context, or NULL on error

Example:

StreamBuffer *sb = sbufCreate(4096);
string output = 0;
sbufStrCRegisterPush(sb, &output);
 
JSONOut *jo = jsonOutBegin(sb, JSON_Pretty);
 
JSONParseEvent ev = {0};
ev.etype = JSON_Object_Begin;
jsonOut(jo, &ev);
 
ev.etype = JSON_Object_Key;
ev.edata.strData = _S"name";
jsonOut(jo, &ev);
 
ev.etype = JSON_String;
ev.edata.strData = _S"value";
jsonOut(jo, &ev);
 
ev.etype = JSON_Object_End;
jsonOut(jo, &ev);
 
jsonOutEnd(&jo);

jsonOutEnd()

void jsonOutEnd

(

JSONOut **

jo

)

void jsonOutEnd(JSONOut **jo)

Finalizes JSON output and cleans up the context.

Flushes any remaining data to the stream buffer, finishes the producer, and frees the JSON output context.

Parameters

jo	Pointer to JSON output context (set to NULL after call)