webpa_parameter.h File Reference

#include <wdmp-c.h>
#include "webpa_adapter.h"

Include dependency graph for webpa_parameter.h:

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

Go to the source code of this file.

Macros
#define	WEBPA_DATA_MODEL_FILE   "/etc/data-model.xml"
#define	MAX_NUM_PARAMETERS   2048
#define	MAX_DATATYPE_LENGTH   48
#define	MAX_PARAM_LENGTH   TR69HOSTIFMGR_MAX_PARAM_LEN
#define	MAX_PARAMETER_LENGTH   512
#define	MAX_PARAMETERVALUE_LEN   128

Functions
void	getValues (const char *paramName[], const unsigned int paramCount, param_t ***paramValArr, size_t **retValCount, WDMP_STATUS **retStatus)
	getValues interface returns the parameter values. More...
void	setValues (const ParamVal paramVal[], const unsigned int paramCount, const WEBPA_SET_TYPE setType, money_trace_spans *timeSpan, WDMP_STATUS **retStatus, char *transaction_id)
	setValues interface sets the parameter value. More...

yes

@description This file describes the Webpa Abstraction Layer

Definition in file webpa_parameter.h.

Function Documentation

getValues()

void getValues	(	const char *	paramName[],
		const unsigned int	paramCount,
		param_t ***	paramValArr,
		size_t **	retValCount,
		WDMP_STATUS **	retStatus
	)

getValues interface returns the parameter values.

getValues supports an option to pass wildward parameters. This can be achieved by passing an object name followed by '.' instead of parameter name.

Parameters

[in]	paramName	List of Parameters.
[in]	paramCount	Number of parameters.
[out]	timeSpan	timing_values for each component.
[out]	paramValArr	Two dimentional array of parameter name/value pairs.
[out]	retValCount	List of "number of parameters" for each input paramName. Usually retValCount will be 1 except for wildcards request where it represents the number of param/value pairs retrieved for the particular wildcard parameter.
[out]	retStatus	List of Return status.

getValues supports an option to pass wildward parameters. This can be achieved by passing an object name followed by '.' instead of parameter name.

Parameters

[in]	paramName	List of Parameters.
[in]	paramCount	Number of parameters.
[out]	paramValArr	Two dimentional array of parameter name/value pairs.
[out]	retValCount	List of "number of parameters" for each input paramName. Usually retValCount will be 1 except for wildcards request where it represents the number of param/value pairs retrieved for the particular wildcard parameter.
[out]	retStatus	List of Return status.

Definition at line 68 of file webpa_parameter.cpp.

setValues()

void setValues	(	const ParamVal	paramVal[],
		const unsigned int	paramCount,
		const WEBPA_SET_TYPE	setType,
		money_trace_spans *	timeSpan,
		WDMP_STATUS **	retStatus,
		char *	transaction_id
	)

setValues interface sets the parameter value.

Parameters

[in]	paramVal	List of Parameter name/value pairs.
[in]	paramCount	Number of parameters.
[in]	setType	Flag to specify the type of set operation.
[out]	timeSpan	timing_values for each component.
[out]	retStatus	List of Return status.
[in]	paramVal	List of Parameter name/value pairs.
[in]	paramCount	Number of parameters.
[out]	retStatus	List of Return status.

Definition at line 95 of file webpa_parameter.cpp.