Runtime value accessors

Files
file	afw_runtime_value_accessor.h
	Core runtime value accessors.

Functions
void	afw_runtime_register_core_value_accessors (afw_xctx_t *xctx)
	Register core runtime value accessors. More...
const afw_value_t *	afw_runtime_value_accessor_default (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor 'default' for default internal. More...
const afw_value_t *	afw_runtime_value_accessor_compile_type (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor 'compile_type'. More...
const afw_value_t *	afw_runtime_value_accessor_indirect (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor 'indirect' for indirect internal. More...
const afw_value_t *	afw_runtime_value_accessor_octet (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for afw_octet_t as afw_integer_t. More...
const afw_value_t *	afw_runtime_value_accessor_stopping_adaptor_instances (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for stopping adaptor instance reference counts. More...
const afw_value_t *	afw_runtime_value_accessor_stopping_authorization_handler_instances (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for stopping authorization handler reference counts. More...
const afw_value_t *	afw_runtime_value_accessor_null_terminated_array_of_internal (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for NULL terminated list of internal. More...
const afw_value_t *	afw_runtime_value_accessor_null_terminated_array_of_objects (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for NULL terminated list of objects. More...
const afw_value_t *	afw_runtime_value_accessor_null_terminated_array_of_utf8_z_key_value_pair_objects (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for NULL terminated list of utf8_z key/value pair objects. More...
const afw_value_t *	afw_runtime_value_accessor_null_terminated_array_of_pointers (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for NULL terminated list of internal pointers. More...
const afw_value_t *	afw_runtime_value_accessor_null_terminated_array_of_values (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for NULL terminated list of values. More...
const afw_value_t *	afw_runtime_value_accessor_service_startup (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for afw_service_startup_t. More...
const afw_value_t *	afw_runtime_value_accessor_service_status (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for afw_service_status_t. More...
const afw_value_t *	afw_runtime_value_accessor_size (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for afw_size_t as afw_integer_t. More...
const afw_value_t *	afw_runtime_value_accessor_uint32 (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for afw_uint32_t as afw_integer_t. More...
const afw_value_t *	afw_runtime_value_accessor_adaptor_metrics (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for /afw/_AdaptiveAdaptorMetrics_/<adaptorId>. More...
const afw_value_t *	afw_runtime_value_accessor_adaptor_additional_metrics (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor to call afw_adaptor_get_additional_metrics(). More...
const afw_value_t *	afw_runtime_value_accessor_ensure_afw_components_extension_loaded (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor to ensure afw_components extension is loaded. More...
const afw_value_t *	afw_runtime_value_accessor_applicable_flags (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor to produce triggeredBy for a flag. More...
const afw_value_t *	afw_runtime_value_accessor_value (const afw_runtime_object_map_property_t *prop, const void *internal, const afw_pool_t *p, afw_xctx_t *xctx)
	Runtime value accessor for an afw_value_t. More...

Detailed Description

This is an Adaptive Framework core runtime value accessors.

Function Documentation

afw_runtime_register_core_value_accessors()

void afw_runtime_register_core_value_accessors

(

afw_xctx_t *

xctx

)

Register core runtime value accessors.

Parameters

xctx	of caller.

Definition at line 19 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_adaptor_additional_metrics()

const afw_value_t* afw_runtime_value_accessor_adaptor_additional_metrics	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor to call afw_adaptor_get_additional_metrics().

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer start of afw_adaptor_impl_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

The data_type in prop must be object.

Parameter internal is mapped by afw_adaptor_impl_t. The value will be the result of calling afw_adaptor_get_additional_metrics() with the adaptor pointed to by afw_adaptor_impl_t.

Definition at line 599 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_adaptor_metrics()

const afw_value_t* afw_runtime_value_accessor_adaptor_metrics	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for /afw/_AdaptiveAdaptorMetrics_/<adaptorId>.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer const afw_utf8_t *adaptor_id.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

The data_type in prop must be object.

Parameter internal is mapped afw_utf8_t *adaptor_id. The value will be the result of getting the runtime /afw/_AdaptiveAdaptorMetrics_/<adaptorId>.

Definition at line 408 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_applicable_flags()

const afw_value_t* afw_runtime_value_accessor_applicable_flags	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor to produce triggeredBy for a flag.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer to flag_id.
p	is pool to use.
xctx	of caller.

Returns

true if was loaded.

The data_type in prop must be list.

Parameter internal must be afw_flag_t flag_id member.

Definition at line 424 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_compile_type()

const afw_value_t* afw_runtime_value_accessor_compile_type	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor 'compile_type'.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer afw_compile_type_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

This value accessor will return the string value for a afw_compile_type_t internal value.

Definition at line 191 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_default()

const afw_value_t* afw_runtime_value_accessor_default	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor 'default' for default internal.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer to internal for result afw_value_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

This is the default value accessor. It uses the information in afw_runtime_object_map_property and expects internal to point directly to the value used as internal for the created afw_value_t.

Definition at line 145 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_ensure_afw_components_extension_loaded()

const afw_value_t* afw_runtime_value_accessor_ensure_afw_components_extension_loaded	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor to ensure afw_components extension is loaded.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer to afw_components_t->object_id.
p	is pool to use.
xctx	of caller.

Returns

true if was loaded.

The data_type in prop must be object.

Parameter internal is mapped by afw_adaptor_impl_t object_id member.

Definition at line 614 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_indirect()

const afw_value_t* afw_runtime_value_accessor_indirect	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor 'indirect' for indirect internal.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer to pointer of internal for result afw_value_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

This is like afw_runtime_value_accessor_default(), but expects internal to point to a pointer to the value used as internal for the created afw_value_t.

An example of when this is used, is if internal is a pointer to afw_utf8_t * instead of afw_utf8_t.

Definition at line 207 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_null_terminated_array_of_internal()

const afw_value_t* afw_runtime_value_accessor_null_terminated_array_of_internal	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for NULL terminated list of internal.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is const afw_object_t * const * with last entry NULL.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

Definition at line 448 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_null_terminated_array_of_objects()

const afw_value_t* afw_runtime_value_accessor_null_terminated_array_of_objects	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for NULL terminated list of objects.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is const afw_object_t * const * with last entry NULL.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

Definition at line 485 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_null_terminated_array_of_pointers()

const afw_value_t* afw_runtime_value_accessor_null_terminated_array_of_pointers	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for NULL terminated list of internal pointers.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is const afw_object_t * const * with last entry NULL.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

Definition at line 546 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_null_terminated_array_of_utf8_z_key_value_pair_objects()

const afw_value_t* afw_runtime_value_accessor_null_terminated_array_of_utf8_z_key_value_pair_objects	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for NULL terminated list of utf8_z key/value pair objects.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	const afw_utf8_z_t *[] (See description).
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

The internal parameter is an array of const afw_utf8_z_t * key/value pairs. Each object is terminated with a NULL and the final object is indicated with an extra NULL.

Example:

static const afw_utf8_z_t * impl_eq_anyURI_errorsThrown[] = { "error", "conversion", "reason", "arg2 cannot be converted to the data type of arg1.", NULL, "error", "arg_error", "reason", "General parameter issue..", NULL, NULL };

Definition at line 505 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_null_terminated_array_of_values()

const afw_value_t* afw_runtime_value_accessor_null_terminated_array_of_values	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for NULL terminated list of values.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is const afw_value_t * const * with last entry NULL.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

Definition at line 584 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_octet()

const afw_value_t* afw_runtime_value_accessor_octet	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for afw_octet_t as afw_integer_t.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer to afw_size_t for result afw_value_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

The data_type in prop must be integer.

Definition at line 221 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_service_startup()

const afw_value_t* afw_runtime_value_accessor_service_startup	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for afw_service_startup_t.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer to afw_size_t for result afw_value_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

The data_type in prop must be integer.

Definition at line 352 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_service_status()

const afw_value_t* afw_runtime_value_accessor_service_status	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for afw_service_status_t.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer to afw_size_t for result afw_value_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

The data_type in prop must be integer.

Definition at line 367 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_size()

const afw_value_t* afw_runtime_value_accessor_size	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for afw_size_t as afw_integer_t.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer to afw_size_t for result afw_value_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

The data_type in prop must be integer.

Definition at line 382 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_stopping_adaptor_instances()

const afw_value_t* afw_runtime_value_accessor_stopping_adaptor_instances	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for stopping adaptor instance reference counts.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is adaptor_id afw_utf8_t **.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

Definition at line 234 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_stopping_authorization_handler_instances()

const afw_value_t* afw_runtime_value_accessor_stopping_authorization_handler_instances	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for stopping authorization handler reference counts.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is authorization_handler_id afw_utf8_t **.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

Definition at line 292 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_uint32()

const afw_value_t* afw_runtime_value_accessor_uint32	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for afw_uint32_t as afw_integer_t.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer to afw_size_t for result afw_value_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

The data_type in prop must be integer.

Definition at line 395 of file afw_runtime_value_accessor.c.

afw_runtime_value_accessor_value()

const afw_value_t* afw_runtime_value_accessor_value	(	const afw_runtime_object_map_property_t *	prop,
		const void *	internal,
		const afw_pool_t *	p,
		afw_xctx_t *	xctx
	)

Runtime value accessor for an afw_value_t.

Parameters

prop	is associated afw_runtime_object_map_property_t.
internal	is pointer start of afw_adaptor_impl_t.
p	is pool to use.
xctx	of caller.

Returns

afw_value_t representing value.

The data_type in prop can be anything. Parameter internal must point to a afw_value_t *.

Definition at line 627 of file afw_runtime_value_accessor.c.