bodyEncode.h File Reference

API for encoding EXI stream body. More...

#include "errorHandle.h"
#include "procTypes.h"

Go to the source code of this file.

Functions
errorCode	encodeProduction (EXIStream *strm, EventTypeClass eventClass, boolean isSchemaType, QName *qname, EXITypeClass chTypeClass, Production *prodHit)
	Finds the grammar production based on the event (and eventually the qname in case of SE and AT) More...
errorCode	encodeStringData (EXIStream *strm, String strng, QNameID qnameID, Index typeId)
	Encodes String value into EXI stream. More...
errorCode	encodeQName (EXIStream *strm, QName qname, EventType eventT, QNameID *qnameID)
	Encodes QName into EXI stream. More...
errorCode	encodeUri (EXIStream *strm, String *uri, SmallIndex *uriID)
	Encodes URI into EXI stream. More...
errorCode	encodeLn (EXIStream *strm, String *ln, QNameID *qnameID)
	Encodes Local Name into EXI stream. More...
errorCode	encodePfxQName (EXIStream *strm, QName *qname, EventType eventT, SmallIndex uriID)
	Encodes the prefix part of the QName into the EXI stream in case the Preserve.prefixes == TRUE. More...
errorCode	encodePfx (EXIStream *strm, SmallIndex uriID, String *prefix)
	Encodes the prefix part of the NS event into the EXI stream. More...
errorCode	encodeIntData (EXIStream *strm, Integer int_val, QNameID qnameID, Index typeId)
	Encodes Integer value into EXI stream. More...

Detailed Description

Date

Sep 7, 2010

Author

Rumen Kyusakov

Version

0.5

[Revision] $Id: bodyEncode.h 328 2013-10-30 16:00:10Z kjussakov $

Definition in file bodyEncode.h.

Function Documentation

errorCode encodeIntData	(	EXIStream *	strm,
		Integer	int_val,
		QNameID	qnameID,
		Index	typeId
	)

Parameters

[in,out]	strm	EXI stream
[in]	int_val	integer to be written
[in]	qnameID	The uri/ln ids in the URI string table
[in]	typeId	index in the type table. It is used to determine the EXI int type and additional restrictions

Returns

Error handling code

Definition at line 753 of file bodyEncode.c.

errorCode encodeLn	(	EXIStream *	strm,
		String *	ln,
		QNameID *	qnameID
	)

Parameters

[in,out]	strm	EXI stream
[in]	ln	local name to be written
[out]	qnameID	id of the qname in the URI and LN string tables

Returns

Error handling code

Definition at line 667 of file bodyEncode.c.

errorCode encodePfx	(	EXIStream *	strm,
		SmallIndex	uriID,
		String *	prefix
	)

Parameters

[in,out]	strm	EXI stream
[in]	uriID	id of the uri row of the URI the string table
[in]	prefix	prefix to be written

Returns

Error handling code

Definition at line 731 of file bodyEncode.c.

errorCode encodePfxQName	(	EXIStream *	strm,
		QName *	qname,
		EventType	eventT,
		SmallIndex	uriID
	)

Parameters

[in,out]	strm	EXI stream
[in]	qname	qname to be written
[in]	eventT	(EVENT_SE_ALL or EVENT_AT_ALL) used for error checking purposes: If the given prefix does not exist in the associated partition, the QName MUST be part of an SE event and the prefix MUST be resolved by one of the NS events immediately following the SE event (see resolution rules below).
[in]	uriID	the QName uriID

Returns

Error handling code

Definition at line 696 of file bodyEncode.c.

errorCode encodeProduction	(	EXIStream *	strm,
		EventTypeClass	eventClass,
		boolean	isSchemaType,
		QName *	qname,
		EXITypeClass	chTypeClass,
		Production *	prodHit
	)

Parameters

[in,out]	strm	EXI stream
[in]	eventClass	event class type to be looked up
[in]	isSchemaType	determine if the data type should be encoded as non-schema type
[in]	qname	element or attribute QName in case of SE or AT events; NULL otherwise
[in]	chTypeClass	the type of the "value" content of CH EXI events; if not CH event then VALUE_TYPE_NONE_CLASS
[out]	prodHit	the matched grammar production

Returns

Error handling code

Definition at line 108 of file bodyEncode.c.

errorCode encodeQName	(	EXIStream *	strm,
		QName	qname,
		EventType	eventT,
		QNameID *	qnameID
	)

Parameters

[in,out]	strm	EXI stream
[in]	qname	qname to be written
[in]	eventT	(EVENT_SE_ALL or EVENT_AT_ALL) used for error checking purposes: If the given prefix does not exist in the associated partition, the QName MUST be part of an SE event and the prefix MUST be resolved by one of the NS events immediately following the SE event (see resolution rules below).
[out]	qnameID	the QName ID

Returns

Error handling code

Definition at line 629 of file bodyEncode.c.

errorCode encodeStringData	(	EXIStream *	strm,
		String	strng,
		QNameID	qnameID,
		Index	typeId
	)

Parameters

[in,out]	strm	EXI stream
[in]	strng	string to be written
[in]	qnameID	The uri/ln ids in the URI string table
[in]	typeId	constraints and restrictions on the String type according to the grammar production

Returns

Error handling code

Definition at line 34 of file bodyEncode.c.

errorCode encodeUri	(	EXIStream *	strm,
		String *	uri,
		SmallIndex *	uriID
	)

Parameters

[in,out]	strm	EXI stream
[in]	uri	uri to be written
[out]	uriID	id of the uri row written in the string table

Returns

Error handling code

Definition at line 646 of file bodyEncode.c.