/build/mod-eppd-2.29.0/epp_gen.h File Reference

#include "epp_common.h"

Include dependency graph for epp_gen.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	XSI   "http://www.w3.org/2001/XMLSchema-instance"
#define	epp_gen_dummy_response(p_epp_ctx, p_cdata, pp_response)    epp_gen_response(p_epp_ctx, 0, NULL, LANG_EN, p_cdata, pp_response, NULL)

Enumerations
enum	gen_status {   GEN_OK , GEN_EBUFFER , GEN_EWRITER , GEN_EBUILD ,   GEN_NOT_XML , GEN_EINTERNAL , GEN_ESCHEMA , GEN_NOT_VALID }

Functions
gen_status	epp_gen_greeting (void *pool, const char *svid, const char *date, const eppd_server_xml_conf *xml_schema, char **greeting)
gen_status	epp_gen_response (epp_context *epp_ctx, int validate, void *schema, epp_lang lang, epp_command_data *cdata, char **response, qhead *valerr)

Detailed Description

Interface to component which generates xml documents and returns result in form of a string.

Macro Definition Documentation

epp_gen_dummy_response

#define epp_gen_dummy_response	(		p_epp_ctx,
			p_cdata,
			pp_response
	)		epp_gen_response(p_epp_ctx, 0, NULL, LANG_EN, p_cdata, pp_response, NULL)

Convenient wrapper around epp_gen_response for error cases.

Parameters

p_epp_ctx	Epp context (session id, connection and pool).
p_cdata	Input values
pp_response	Result of generation phase = generated string.

XSI

#define XSI   "http://www.w3.org/2001/XMLSchema-instance"

Namespace used for specifing location of a schema in xml document.

Enumeration Type Documentation

gen_status

enum gen_status

XML generator status values.

Enumerator
GEN_OK	No error appeared, everything was allright.
GEN_EBUFFER	Could not create xml buffer.
GEN_EWRITER	Could not create xml writer.
GEN_EBUILD	Error when building xml document.
GEN_NOT_XML	Something what is not xml was generated.
GEN_EINTERNAL	Malloc failure during response validation.
GEN_ESCHEMA	Error when parsing xml schema used for validation.
GEN_NOT_VALID	Response does not validate.

Function Documentation

epp_gen_greeting()

gen_status epp_gen_greeting	(	void *	pool,
		const char *	svid,
		const char *	date,
		const eppd_server_xml_conf *	xml_schema,
		char **	greeting
	)

Routine makes up epp greeting frame.

Parameters

pool	Pool to allocate memory from.
svid	Part of server ID used in svid tag.
date	Current date as returned from server.
xml_schema	Entities enabled in xml schemas.
greeting	Greeting string.

Returns

Generator status.

epp_gen_response()

gen_status epp_gen_response	(	epp_context *	epp_ctx,
		int	validate,
		void *	schema,
		epp_lang	lang,
		epp_command_data *	cdata,
		char **	response,
		qhead *	valerr
	)

Generate command response in XML format.

There is option that response can be validated, the validation errors are then returned together with generated string in form of a list.

Parameters

epp_ctx	Epp context (session id, connection and pool).
validate	Tells if response should be validated or not (boolean).
schema	Schema against which to validate.
lang	Language selected by the client.
cdata	Input values
response	Result of generation phase = generated string.
valerr	List of validation errors if validation is turned on.

Returns

Generator status.