Files
file	afw_common.h
	Adaptive Framework Common Header.

file	afw_common_opaques.h
	Adaptive Framework Common Opaques Header.

file	afw_interface_common.h
	Adaptive Framework Interface Common Header.

Data Structures
struct	afw_memory_s
	Struct for memory pointer and size. More...

struct	afw_utf8_s
	NFC normalized UTF-8 string. More...

union	afw_utf8_utf8_z_s
	NFC normalized UTF-8 string accessible as afw_utf8_t or afw_utf8_z_t. More...

struct	afw_utf8_array_s
	Array of strings. More...

struct	afw_stack_s
	Struct for afw_stack_t typedef. More...

struct	afw_name_value_s
	Typedef for name/value pair. More...

struct	afw_key_string_s
	Typedef for key/string pair. More...

struct	afw_key_z_string_z_s
	Typedef for key/string pair that have both utf8 and utf8_z. More...

struct	afw_object_meta_s
	Typedef for meta variable in afw_object interface. More...

struct	afw_environment_s
	Struct for typedef afw_environment_t defined in afw_common.h. More...

union	afw_c_types_u
	Typedef for union of all cType. More...

struct	afw_time_with_offset_s
	Time with offset (old) More...

struct	afw_yearMonthDuration_s
	yearMonth duration More...

struct	afw_dayTimeDuration_s
	dayTime duration More...

struct	afw_time_duration_s
	Time duration. More...

struct	afw_time_zone_s
	time zone More...

struct	afw_date_no_time_zone_s
	date with no time zone. More...

struct	afw_date_s
	date with time zone. More...

struct	afw_time_no_time_zone_s
	time with no time zone. More...

struct	afw_time_s
	time with time zone. More...

struct	afw_dateTime_s
	date, time, and time zone. More...

struct	afw_interface_rti_variable_s
	Interface Variable Run Time Information. More...

struct	afw_interface_rti_method_s
	Interface Method Run Time Information. More...

struct	afw_interface_rti_s
	Interface Run Time Information. More...

struct	afw_interface_implementation_rti_s
	Interface Implementation Run Time Information. More...

struct	afw_interface_s
	Minimal Interface. More...

struct	afw_instance_s
	Minimal Instance. More...

Macros
#define	AFW_POSSIBLY_UNUSED_VARIABLE
	Macro to avoid unused variable warning. More...

#define	AFW_ASSERT(e) assert(e)

#define	offsetof(type, member) __builtin_offsetof (type, member)

#define	AFW_ADAPTOR_ID "afw"

#define	AFW_STRINGIFY(x) AFW_STRINGIFY_x(x)
	Evaluate x and quote the results.

#define	AFW_STRINGIFY_x(x) #x

#define	AFW__FILE_LINE__ __FILE__ ":" AFW_STRINGIFY(__LINE__)
	file:line

#define	AFW_INT32_MIN -2147483647 - 1
	Min int32.

#define	AFW_INT32_MAX 2147483647
	Max int32.

#define	AFW_UINT16_MAX 65536
	Max uint32.

#define	AFW_UINT32_MAX 4294967296
	Max uint32.

#define	AFW_UTF8_Z_LEN -1
	String is NUL (0) terminate. More...

#define	AFW_INTEGER_MAX_BUFFER 21
	this is the maximum number of digits that can be produced by afw_integer_t plus negative sign plus null terminator. Largest negative 64 bit int is -9223372036854775808 Largest positive 64 bit int is 9223372036854775807

#define	AFW_INTEGER_MAX APR_INT64_MAX
	largest afw_integer_t

#define	AFW_INTEGER_Q_MAX "9223372036854775807"
	largest afw_integer_t quoted

#define	AFW_INTEGER_MIN APR_INT64_MIN
	smallest afw_integer_t

#define	AFW_INTEGER_Q_MIN "-9223372036854775808"
	smallest afw_integer_t quoted

#define	AFW_INTEGER_MAX_SAFE_DOUBLE 9007199254740991
	largest afw_integer_t value that a double can hold.

#define	AFW_INTEGER_MIN_SAFE_DOUBLE -9007199254740991
	smallest afw_integer_t value that a double can hold.

#define	AFW_INTEGER_IS_SAFE_DOUBLE(integer)
	Tests integer to be safely held in a double. More...

#define	AFW_INTEGER_FMT APR_INT64_T_FMT
	Format string specifier used for afw_integer_t.

#define	AFW_INTEGER_MAX_DIGITS 19
	afw_integer_t max digits.

#define	AFW_Q_INTEGER_MAX_DIGITS "19"
	afw_integer_t max digits in quotes.

#define	AFW_SIZE_T_FMT APR_SIZE_T_FMT
	Format string specifier used for afw_size_t.

#define	AFW_SIZE_T_MAX APR_SIZE_MAX
	afw_size_t max.

#define	AFW_SIZE_T_MAX_DIGITS 19
	afw_size_t max digits.

#define	AFW_Q_SIZE_T_MAX_DIGITS "19"
	afw_size_t max digits in quotes.

#define	AFW_SIZE_T_MAX_BUFFER AFW_SIZE_T_MAX_DIGITS + 1
	this is the maximum number of digits that can be produced by afw_size_t plus null terminator.

#define	AFW_TRUE true

#define	AFW_FALSE false

#define	AFW_CRLF "\x0d\x0a"

#define	AFW_CRLF_STRLEN 2

#define	AFW_COMPILE_TYPE_MAP(XX)
	Compile Type Map. More...

#define	AFW_UTF8_LITERAL(A_STRING) {A_STRING, sizeof(A_STRING) - 1}
	String literal initializer. More...

#define	AFW_UTF8_FMT ".*s"
	Format string specifier used for afw_utf8_t.

#define	AFW_UTF8_CONTEXTUAL_LABEL_FMT_SEP "> "
	Format string used for source location separator.

#define	AFW_UTF8_CONTEXTUAL_LABEL_FMT AFW_UTF8_FMT AFW_UTF8_CONTEXTUAL_LABEL_FMT_SEP
	Format string used for source location.

#define	AFW_UTF8_FMT_ARG(A_STRING) (int)(A_STRING)->len, (const char *)(A_STRING)->s
	Convenience Macro for use with AFW_UTF8_FMT to specify arg. More...

#define	AFW_UTF8_FMT_OPTIONAL_ARG(A_STRING)
	Convenience Macro for use with AFW_UTF8_FMT to specify optional arg. More...

#define	AFW_UTF8_FMT_OPTIONAL_UNDEFINED_ARG(A_STRING)
	Convenience Macro for use with AFW_UTF8_FMT to specify optional arg. More...

#define	AFW_MESSAGE_PREFIX __FILE__ ":" AFW_STRINGIFY(__LINE__) " "
	Macro to produce prefix for AFW messages.

#define	AFW_UTF8_ENCODING "UTF-8"
	UTF-8 encoding.

#define	AFW_STACK_STRUCT(struct_name, entry_type)
	Define a struct for a stack with the specified entry type. More...

#define	AFW_ERROR_CODE_MAP(XX)
	Error code map. IMPORTANT>>> Do not change the order of these entries. The order must match the order of the error codes in afw_error_code_t as originally released since the internal number will be externally compile in. More...

#define	AFW_SERVICE_STARTUP_MAP(XX)
	Map used for afw_service_startup_t enum. More...

#define	AFW_SERVICE_STATUS_MAP(XX)
	Map used for afw_service_status_t enum. More...

#define	afw_thread_mutex_t apr_thread_mutex_t
	Uses apr_thread_mutex_t asis. See afw_thread.h.

#define	afw_thread_mutex_create apr_thread_mutex_create
	Uses apr_thread_mutex_t asis.

#define	afw_thread_mutex_lock apr_thread_mutex_lock
	Uses apr_thread_mutex_t asis.

#define	afw_thread_mutex_trylock apr_thread_mutex_trylock
	Uses apr_thread_mutex_trylock asis.

#define	afw_thread_mutex_unlock apr_thread_mutex_unlock
	Uses apr_thread_mutex_unlock asis.

#define	afw_thread_mutex_destroy apr_thread_mutex_destroy
	Uses apr_thread_mutex_destroy asis.

#define	AFW_THREAD_FUNCTION APR_THREAD_FUNC
	Uses APR_THREAD_FUNC as AFW_THREAD_FUNCTION.

#define	AFW_ENVIRONMENT_DEFAULT_EVALUATION_STACK_INITIAL_COUNT 100
	Default for afw_environment_t evaluation_stack_initial_count.

#define	AFW_ENVIRONMENT_DEFAULT_EVALUATION_STACK_MAXIMUM_COUNT 200
	Default for afw_environment_t evaluation_stack_maximum_count.

Typedefs
typedef apr_size_t	afw_size_t
	size_t.

typedef apr_off_t	afw_off_t
	off_t.

typedef int8_t	afw_int8_t
	8-bit signed integer.

typedef apr_int16_t	afw_int16_t
	16-bit signed integer.

typedef apr_int32_t	afw_int32_t
	32-bit signed integer.

typedef apr_int64_t	afw_int64_t
	64-bit signed integer.

typedef uint8_t	afw_uint8_t
	8-bit unsigned integer.

typedef apr_uint16_t	afw_uint16_t
	16-bit unsigned integer.

typedef apr_uint32_t	afw_uint32_t
	32-bit unsigned integer.

typedef apr_uint64_t	afw_uint64_t
	64-bit unsigned integer.

typedef float	afw_float32_t
	32-bit float.

typedef double	afw_float64_t
	64-bit float.

typedef double	afw_float_t
	Normal float.

typedef double	afw_double_t
	Normal AFW number is double.

typedef afw_int32_t	afw_code_point_t
	Unicode code point.

typedef unsigned char	afw_byte_t
	A byte of memory (unsigned). More...

typedef unsigned char	afw_octet_t
	8 bits (unsigned). More...

typedef char	afw_utf8_octet_t
	8 bits of utf-8 codepoint. More...

typedef afw_code_point_t(*	afw_code_point_get_cb_t) (void data, afw_xctx_t xctx)
	Get Unicode code point callback. More...

typedef int(*	afw_utf8_octet_get_cb_t) (afw_utf8_octet_t octet, void data, afw_xctx_t *xctx)
	Get an utf-8 octet (8 bits). More...

typedef apr_int64_t	afw_integer_t
	typedef for big signed int.

typedef apr_uint64_t	afw_unsigned_integer_t
	typedef for big unsigned int.

typedef _Bool	afw_boolean_t

typedef enum afw_compile_type_e	afw_compile_type_t
	Compile type enum.

typedef struct afw_memory_s	afw_memory_t
	Struct for memory pointer and size. More...

typedef afw_utf8_octet_t	afw_utf8_z_t
	NFC normalized UTF-8 null terminated string. More...

typedef struct afw_utf8_s	afw_utf8_t
	NFC normalized UTF-8 string. More...

typedef union afw_utf8_utf8_z_s	afw_utf8_utf8_z_t
	NFC normalized UTF-8 string accessible as afw_utf8_t or afw_utf8_z_t.

typedef struct afw_utf8_array_s	afw_utf8_array_t
	Array of strings.

typedef uint32_t	afw_u_cp_t
	A Unicode codepoint. Range is 0 to 0x10ffff. Other values are illegal Unicode codepoints.

typedef char *	afw_uri_t
	this implementation uses UTF-8.

typedef int	afw_log_priority_mask_t

typedef int	afw_rc_t

typedef struct afw_name_value_s	afw_name_value_t
	Typedef for name/value pair.

typedef struct afw_key_string_s	afw_key_string_t
	Typedef for key/string pair.

typedef struct afw_key_z_string_z_s	afw_key_z_string_z_t
	Typedef for key/string pair that have both utf8 and utf8_z.

typedef struct afw_object_meta_s	afw_object_meta_t
	Typedef for meta variable in afw_object interface. More...

typedef enum afw_error_code_e	afw_error_code_t

typedef void(*	afw_pool_cleanup_function_p_t) (void data, void data2, const afw_pool_t p, afw_xctx_t xctx)
	Typedef for pool cleanup functions. More...

typedef const afw_value_t (	afw_xctx_get_variable_t) (const afw_xctx_qualifier_stack_entry_t entry, const afw_utf8_t name, afw_xctx_t *xctx)
	Typedef for function to get a qualified variable. More...

typedef enum afw_log_priority_e	afw_log_priority_t
	Log levels. See afw_log.h for more information.

typedef enum afw_adaptor_journal_option_e	afw_adaptor_journal_option_t
	Typedef for afw_adaptor_journal get_entry options enum. More...

typedef afw_boolean_t(*	afw_object_cb_t) (const afw_object_t object, void context, afw_xctx_t *xctx)
	Typedef for afw_adaptor_session_object callback. More...

typedef afw_boolean_t(*	afw_value_cb_t) (const void value, void context, afw_xctx_t *xctx)
	Typedef for value callback. More...

typedef afw_size_t(*	afw_read_cb_t) (void context, const void buffer, afw_size_t size, afw_boolean_t more_to_read, const afw_pool_t p, afw_xctx_t *xctx)
	Typedef for read callback function. More...

typedef afw_size_t(*	afw_write_cb_t) (void context, const void buffer, afw_size_t size, const afw_pool_t p, afw_xctx_t xctx)
	Typedef for write callback function. More...

typedef const afw_value_t (	afw_runtime_value_accessor_t) (const afw_runtime_object_map_property_t property, const void internal, const afw_pool_t p, afw_xctx_t xctx)

typedef const afw_value_t (	afw_function_execute_cb_t) (afw_function_execute_t *x)
	Typedef for function execute functions. More...

typedef const afw_value_t (	afw_function_thunk_execute_t) (const afw_value_function_thunk_t function, afw_size_t argc, const afw_value_t const argv, const afw_pool_t p, afw_xctx_t *xctx)
	Typedef for function thunk execute functions. More...

typedef const afw_utf8_t (	afw_function_arg_check_t) (afw_function_execute_t x, afw_size_t argc, const afw_value_t argv[], const afw_pool_t p, afw_xctx_t xctx)
	Typedef for function arg check functions. More...

typedef enum afw_service_startup_e	afw_service_startup_t
	Typedef for service startup type enum. More...

typedef enum afw_service_status_e	afw_service_status_t
	Typedef for service status enum. More...

typedef void (AFW_THREAD_FUNCTION	afw_thread_function_t) (const afw_thread_t thread, void arg)
	Typedef for thread start function.

typedef struct afw_thread_attr_s	afw_thread_attr_t
	Typedef for afw_thread_attr.

typedef union afw_c_types_u	afw_c_types_t
	Typedef for union of all cType.

typedef struct afw_time_with_offset_s	afw_time_with_offset_t
	Time with offset (old) More...

typedef struct afw_yearMonthDuration_s	afw_yearMonthDuration_t
	yearMonth duration More...

typedef struct afw_dayTimeDuration_s	afw_dayTimeDuration_t
	dayTime duration More...

typedef struct afw_time_duration_s	afw_time_duration_t
	Time duration.

typedef struct afw_time_zone_s	afw_time_zone_t
	time zone

typedef struct afw_date_no_time_zone_s	afw_date_no_time_zone_t
	date with no time zone.

typedef struct afw_date_s	afw_date_t
	date with time zone.

typedef struct afw_time_no_time_zone_s	afw_time_no_time_zone_t
	time with no time zone.

typedef struct afw_time_s	afw_time_t
	time with time zone.

typedef struct afw_dateTime_s	afw_dateTime_t
	date, time, and time zone.

typedef void(*	afw_service_wrapper_start_cb) (void data, afw_xctx_t xctx)
	Typedef for service wrapper start call back. More...

typedef void(*	afw_service_wrapper_stop_cb) (void data, afw_xctx_t xctx)
	Typedef for service wrapper stop call back. More...

typedef struct afw_adaptor_id_anchor_s	afw_adaptor_id_anchor_t

typedef struct afw_adaptor_impl_s	afw_adaptor_impl_t

typedef struct afw_adaptor_impl_request_s	afw_adaptor_impl_request_t

typedef struct afw_adaptor_impl_session_s	afw_adaptor_impl_session_t

typedef struct afw_adaptor_internal_cache_s	afw_adaptor_internal_cache_t

typedef struct afw_adaptor_internal_session_cache_s	afw_adaptor_internal_session_cache_t

typedef struct afw_adaptor_modify_entry_s	afw_adaptor_modify_entry_t

typedef struct afw_adaptor_xctx_internal_s	afw_adaptor_xctx_internal_t

typedef struct afw_components_s	afw_components_t
	Application app (afw_app) object. More...

typedef struct afw_authorization_advice_expression_s	afw_authorization_advice_expression_t

typedef struct afw_authorization_combiner_parameter_s	afw_authorization_combiner_parameter_t

typedef struct afw_authorization_internal_control_s	afw_authorization_control_t

typedef struct afw_authorization_decision_s	afw_authorization_decision_t

typedef struct afw_authorization_handler_id_s	afw_authorization_handler_id_t

typedef struct afw_authorization_internal_handler_id_anchor_s	afw_authorization_handler_id_anchor_t

typedef struct afw_authorization_handler_impl_s	afw_authorization_handler_impl_t

typedef struct afw_authorization_obligation_expression_s	afw_authorization_obligation_expression_t

typedef struct afw_authorization_policy_s	afw_authorization_policy_t

typedef struct afw_authorization_policy_issuer_s	afw_authorization_policy_issuer_t

typedef struct afw_authorization_policy_location_s	afw_authorization_policy_location_t

typedef struct afw_authorization_policy_set_s	afw_authorization_policy_set_t

typedef struct afw_authorization_rule_s	afw_authorization_rule_t

typedef struct afw_compile_internal_args_s	afw_compile_args_t

typedef struct afw_compile_internal_assignment_property_s	afw_compile_assignment_property_t

typedef struct afw_compile_internal_assignment_target_s	afw_compile_assignment_target_t

typedef struct afw_compile_internal_list_destructure_s	afw_compile_list_destructure_t

typedef struct afw_compile_assignment_element_s	afw_compile_assignment_element_t

typedef struct afw_compile_internal_object_destructure_s	afw_compile_object_destructure_t

typedef struct afw_compile_internal_parser_s	afw_compile_parser_t

typedef struct afw_compile_internal_token_s	afw_compile_token_t

typedef struct afw_compile_internal_shared_s	afw_compile_shared_t

typedef struct afw_compile_type_info_s	afw_compile_type_info_t

typedef struct afw_utf8_stack_s	afw_utf8_stack_t

typedef struct afw_const_utf8_a_stack_s	afw_const_utf8_a_stack_t

typedef struct afw_context_s	afw_context_t

typedef struct afw_context_cb_variable_meta_s	afw_context_cb_variable_meta_t

typedef struct afw_context_cb_variable_s	afw_context_cb_variable_t

typedef struct afw_environment_s	afw_environment_t

typedef struct afw_environment_conf_type_s	afw_environment_conf_type_t

typedef struct afw_environment_registry_type_s	afw_environment_registry_type_t

typedef struct afw_error_s	afw_error_t

typedef struct afw_error_context_s	afw_error_context_t

typedef struct afw_expression_s	afw_expression_t

typedef struct afw_flag_s	afw_flag_t

typedef struct afw_function_environment_s	afw_function_environment_t

typedef struct afw_function_execute_s	afw_function_execute_t

typedef struct afw_iterator_s	afw_iterator_t

typedef struct afw_lock_s	afw_lock_t

typedef struct afw_lock_rw_s	afw_lock_rw_t

typedef struct afw_log_impl_s	afw_log_impl_t

typedef struct afw_object_meta_object_s	afw_object_meta_object_t

typedef struct afw_model_associative_array_s	afw_model_associative_array_t

typedef struct afw_model_internal_s	afw_model_t

typedef struct afw_model_internal_context_s	afw_model_internal_context_t

typedef struct afw_model_internal_adaptor_self_s	afw_model_internal_adaptor_self_t

typedef struct afw_model_internal_adaptor_session_self_s	afw_model_internal_adaptor_session_self_t

typedef struct afw_model_internal_object_type_s	afw_model_object_type_t

typedef struct afw_model_internal_property_type_s	afw_model_property_type_t

typedef struct afw_model_property_constraint_s	afw_model_property_constraint_t

typedef struct afw_model_location_s	afw_model_location_t

typedef struct afw_name_value_stack_s	afw_name_value_stack_t
	Name/value stack. More...

typedef struct afw_object_options_s	afw_object_options_t
	Object view options. More...

typedef struct afw_object_path_parsed_s	afw_object_path_parsed_t

typedef struct afw_object_path_property_name_entry_s	afw_object_path_property_name_entry_t

typedef struct afw_object_properties_callback_entry_s	afw_object_properties_callback_entry_t

typedef struct afw_object_type_s	afw_object_type_t

typedef struct afw_object_type_property_type_s	afw_object_type_property_type_t

typedef struct afw_query_criteria_s	afw_query_criteria_t

typedef struct afw_query_criteria_filter_entry_s	afw_query_criteria_filter_entry_t

typedef struct afw_runtime_objects_s	afw_runtime_objects_t

typedef struct afw_runtime_object_type_meta_s	afw_runtime_object_type_meta_t

typedef struct afw_runtime_object_map_s	afw_runtime_object_map_t

typedef struct afw_runtime_object_map_property_s	afw_runtime_object_map_property_t

typedef struct afw_runtime_object_indirect_s	afw_runtime_object_indirect_t

typedef struct afw_runtime_const_object_instance_s	afw_runtime_const_object_instance_t

typedef struct afw_runtime_const_object_meta_object_s	afw_runtime_const_object_meta_object_t

typedef struct afw_runtime_custom_s	afw_runtime_custom_t

typedef struct afw_runtime_property_s	afw_runtime_property_t

typedef struct afw_runtime_unresolved_const_list_s	afw_runtime_unresolved_const_list_t

typedef struct afw_runtime_unresolved_const_object_s	afw_runtime_unresolved_const_object_t

typedef struct afw_runtime_unresolved_property_s	afw_runtime_unresolved_property_t

typedef struct afw_runtime_unresolved_const_embedded_untyped_object_s	afw_runtime_unresolved_const_embedded_untyped_object_t

typedef struct afw_runtime_unresolved_value_s	afw_runtime_unresolved_value_t

typedef struct afw_xctx_evaluation_stack_s	afw_xctx_evaluation_stack_t

typedef struct afw_xctx_evaluation_stack_entry_s	afw_xctx_evaluation_stack_entry_t

typedef struct afw_xctx_internal_qualifier_stack_s	afw_xctx_qualifier_stack_t
	Typedef for xctx qualifier stack. More...

typedef struct afw_xctx_qualifier_stack_entry_s	afw_xctx_qualifier_stack_entry_t
	Typedef for xctx qualifier stack entry. More...

typedef struct afw_service_s	afw_service_t
	Typedef for service. More...

typedef struct afw_stack_s	afw_stack_t

typedef struct afw_stream_anchor_s	afw_stream_anchor_t
	Typedef for stream anchor. More...

typedef struct afw_stream_s	afw_stream_t
	Typedef for stream. More...

typedef struct afw_thread_s	afw_thread_t

typedef struct afw_thread_mutex_s	afw_thread_mutex_t

typedef struct afw_try_s	afw_try_t

typedef struct afw_value_annotated_s	afw_value_annotated_t

typedef struct afw_value_assignment_s	afw_value_assignment_t

typedef struct afw_value_assignment_target_s	afw_value_assignment_target_t

typedef struct afw_value_block_s	afw_value_block_t

typedef struct afw_value_block_frame_s	afw_value_block_frame_t

typedef struct afw_value_block_symbol_s	afw_value_block_symbol_t

typedef struct afw_value_call_s	afw_value_call_t

typedef struct afw_value_call_built_in_function_s	afw_value_call_built_in_function_t

typedef struct afw_value_call_args_s	afw_value_call_args_t

typedef struct afw_value_internal_compiled_value_s	afw_value_compiled_value_t

typedef struct afw_value_compiler_listing_s	afw_value_compiler_listing_t

typedef struct afw_compile_internal_value_contextual_s	afw_compile_value_contextual_t

typedef struct afw_value_evaluated_s	afw_value_evaluated_t

typedef struct afw_value_expression_definition_s	afw_value_expression_definition_t

typedef struct afw_value_function_definition_s	afw_value_function_definition_t

typedef struct afw_value_function_parameter_s	afw_value_function_parameter_t

typedef struct afw_value_function_thunk_s	afw_value_function_thunk_t

typedef struct afw_value_info_s	afw_value_info_t

typedef struct afw_value_script_function_definition_s	afw_value_script_function_definition_t

typedef struct afw_value_script_function_parameter_s	afw_value_script_function_parameter_t

typedef struct afw_value_script_function_signature_s	afw_value_script_function_signature_t

typedef struct afw_value_list_expression_s	afw_value_list_expression_t

typedef struct afw_value_object_expression_s	afw_value_object_expression_t

typedef struct afw_value_qualified_variable_reference_s	afw_value_qualified_variable_reference_t

typedef struct afw_value_reference_by_key_s	afw_value_reference_by_key_t

typedef struct afw_value_template_definition_s	afw_value_template_definition_t

typedef struct afw_value_type_s	afw_value_type_t

typedef struct afw_value_type_list_s	afw_value_type_list_t

typedef struct afw_value_variable_reference_s	afw_value_variable_reference_t

typedef struct afw_interface_rti_variable_s	afw_interface_rti_variable_t
	Interface Variable Run Time Information.

typedef struct afw_interface_rti_method_s	afw_interface_rti_method_t
	Interface Method Run Time Information.

typedef struct afw_interface_rti_s	afw_interface_rti_t
	Interface Run Time Information.

typedef struct afw_interface_implementation_rti_s	afw_interface_implementation_rti_t
	Interface Implementation Run Time Information.

typedef struct afw_interface_s	afw_interface_t
	Minimal Interface.

typedef struct afw_instance_s	afw_instance_t
	Minimal Instance.

Enumerations
enum	afw_compile_type_e { afw_compile_type_count }
	Compile type enum.

enum	afw_error_code_e { afw_error_code_is_not_specified = 0 , afw_error_code_highest_afw = 1000 }

enum	afw_log_priority_e { afw_log_priority_invalid = -1 , afw_log_priority_min = 0 , afw_log_priority_emerg = 0 , afw_log_priority_alert = 1 , afw_log_priority_crit = 2 , afw_log_priority_err = 3 , afw_log_priority_warning = 4 , afw_log_priority_notice = 5 , afw_log_priority_info = 6 , afw_log_priority_debug = 7 , afw_log_priority_max = 7 , afw_log_priority_trace_min = 8 , afw_log_priority_trace1 = 8 , afw_log_priority_trace2 = 9 , afw_log_priority_trace3 = 10 , afw_log_priority_trace4 = 11 , afw_log_priority_trace5 = 12 , afw_log_priority_trace6 = 13 , afw_log_priority_trace7 = 14 , afw_log_priority_trace8 = 15 , afw_log_priority_trace_max = 15 }
	Log levels. See afw_log.h for more information. More...

enum	afw_adaptor_journal_option_e { afw_adaptor_journal_option_get_first , afw_adaptor_journal_option_get_by_cursor , afw_adaptor_journal_option_get_next_after_cursor , afw_adaptor_journal_option_get_next_for_consumer , afw_adaptor_journal_option_get_next_for_consumer_after_cursor , afw_adaptor_journal_option_advance_cursor_for_consumer }
	Typedef for afw_adaptor_journal get_entry options enum. More...

enum	afw_service_startup_e { afw_service_startup_invalid }
	Typedef for service startup type enum. More...

enum	afw_service_status_e { afw_service_status_invalid }
	Typedef for service status enum. More...

Functions
	AFW_STACK_STRUCT (afw_utf8_stack_s, afw_utf8_t)
	afw_utf8_t stack struct.

	AFW_STACK_STRUCT (afw_const_utf8_a_stack_s, const afw_utf8_t *)
	const afw_utf8_t * stack struct.

	AFW_STACK_STRUCT (afw_name_value_stack_s, afw_name_value_t)
	const afw_utf8_t * stack struct.

Detailed Description

Common to all Adaptive Framework applications

Macro Definition Documentation

◆ AFW_ADAPTOR_ID

#define AFW_ADAPTOR_ID "afw"

Adaptive Framework's core adaptor id.

Definition at line 141 of file afw_common.h.

◆ AFW_ASSERT

#define AFW_ASSERT ( e ) assert(e)

Todo:: FIXME: Remove this as soon as no source contains it.

Definition at line 131 of file afw_common.h.

◆ AFW_COMPILE_TYPE_MAP

#define AFW_COMPILE_TYPE_MAP ( XX )

Compile Type Map.

Parameters

XX macro

There must be and afw_s_ with each name in map.

Definition at line 409 of file afw_common.h.

◆ AFW_CRLF

#define AFW_CRLF "\x0d\x0a"

The end-of-line marker for HTTP protocol elements.

Definition at line 396 of file afw_common.h.

◆ AFW_CRLF_STRLEN

#define AFW_CRLF_STRLEN 2

The strlen of the end-of-line marker for HTTP protocol elements.

Definition at line 400 of file afw_common.h.

◆ AFW_ERROR_CODE_MAP

#define AFW_ERROR_CODE_MAP ( XX )

Value:

    XX(none,                   true,  200, "OK"                                )\
    XX(general,                true,  500, "General Error"                     )\
    XX(bad_request,            true,  400, "Bad Request"                       )\
    XX(query_too_complex,      true,  400, "Query Too Complex"                 )\
    XX(request_syntax,         true,  400, "Request Syntax Error"              )\
    XX(objects_needed,         true,  400, "Objects Needed To Complete Request")\
    XX(authentication_required,true,  401, "Authentication Needed"             )\
    XX(denied,                 true,  403, "Forbidden - Access Denied"         )\
    XX(read_only,              true,  403, "Forbidden - Read Only"             )\
    XX(not_found,              true,  404, "Not Found"                         )\
    XX(method_not_allowed,     true,  405, "Method Not Allowed"                )\
    XX(unsupported_accept,     false, 406, "Unsupported Content Type Requested")\
    XX(client_time_out,        true,  408, "Request Timeout"                   )\
    XX(im_a_teapot,            true,  418, "I'm a Teapot"                      )\
    XX(conflict,               true,  409, "Conflict"                          )\
    XX(length_required,        true,  411, "Content Length Required"           )\
    XX(payload_too_large,      true,  413, "Payload too large"                 )\
    XX(unsupported_content,    true,  415, "Unsupported Content Type"          )\
    XX(memory,                 true,  500, "Memory Error"                      )\
    XX(syntax,                 true,  500, "Server Side Syntax Error"          )\
    XX(method_not_supported,   true,  501, "Method Not Supported"              )\
    XX(client_closed,          false, 000, "Client Closed Connection"          )\
    XX(assertion_failed,       true,  400, "Assertion failed"                  )\
    XX(cast_error,             true,  400, "Adaptive Type Cast Error"          )\
    XX(arg_error,              true,  400, "Adaptive Function Arg Error"       )\
    XX(evaluate,               true,  400, "Evaluation error"                  )\
    XX(undefined,              true,  400, "Undefined value"                   )\
    XX(code,                   true,  500, "Clearly an internal coding error"  )\

Error code map. IMPORTANT>>> Do not change the order of these entries. The order must match the order of the error codes in afw_error_code_t as originally released since the internal number will be externally compile in.

none - No error has occurred.

general - A general error has occurred that does not match a more specific error code.

evaluate - A error occurred while evaluating an adaptive value.

bad_request - Something about the request was bad.

query_to_complex - The query is too complex for the particular adaptor and/or index.

request_syntax - A error occurred while parsing the request.

objects_needed - This error will not occur if the object whose URI is in error.additional is available in the xctx's cache. Function afw_object_resolve_instance() uses this error code when object is NULL and the object with the URI passed is not in the cache.

authentication_required - Subject authentication required.

denied - The caller is not authorized to perform the request. See error.additional for more information.

read_only - Something is read only. See error.additional for an indication of what is write protected.

not_found - Something was not found. If "not found" is a normal condition that might happen in a function or method, returning NULL or using a parameter should communicate "not found" instead of throwing an error with this error code. For example, function afw_object_get_property() sets its "found" parameter to AFW_FALSE and afw_object_resolve_instance() return NULL to indicate "not found".

method_not_allowed - Method is not allowed for this resource.

unsupported_accept - None of the request's acceptable response content types are supported.

client_time_out - Timed out waiting on client.

conflict - Conflict such as resourse in use.

length_required - Request requires content length.

unsupported_content_type - The request's content type is not supported.

memory - There is not enough memory available to continue.

syntax - A server side syntax error occurred.

method_not_supported - The implementation of this interface does not support this method.

client_closed - Client closed connection.

Map has id, error_allow_in_response, http_response_code, and description.

id: Id of error code error_allow_in_response: If an error is thrown with this id, it's allowed for the HTTP response to include the error object. http_response_code: The HTTP response code to use if this error is thrown. description: A very short description that will be included in after the http_response_code in the status message.

Definition at line 896 of file afw_common.h.

◆ AFW_FALSE

#define AFW_FALSE false

AFW boolean false.

False will always be 0.

Normal C boolean testing can be used for checking.

Definition at line 392 of file afw_common.h.

◆ AFW_INTEGER_IS_SAFE_DOUBLE

#define AFW_INTEGER_IS_SAFE_DOUBLE ( integer )

Value:

((integer) <= AFW_INTEGER_MAX_SAFE_DOUBLE && \

((integer) >= AFW_INTEGER_MIN_SAFE_DOUBLE)

AFW_INTEGER_MIN_SAFE_DOUBLE

#define AFW_INTEGER_MIN_SAFE_DOUBLE

smallest afw_integer_t value that a double can hold.

Definition: afw_common.h:306

AFW_INTEGER_MAX_SAFE_DOUBLE

#define AFW_INTEGER_MAX_SAFE_DOUBLE

largest afw_integer_t value that a double can hold.

Definition: afw_common.h:301

Tests integer to be safely held in a double.

Parameters

integer to test.

Returns: boolean result.

Definition at line 313 of file afw_common.h.

◆ AFW_POSSIBLY_UNUSED_VARIABLE

#define AFW_POSSIBLY_UNUSED_VARIABLE

Macro to avoid unused variable warning.

This avoids GCC warning unused-variable when placed before a variable.

Example:

AFW_POSSIBLY_UNUSED_VARIABLE afw_boolean_t this_FINALLY_ENTERED = false;

Definition at line 127 of file afw_common.h.

◆ AFW_SERVICE_STARTUP_MAP

#define AFW_SERVICE_STARTUP_MAP ( XX )

Value:

    XX(disabled,    "Service is disabled and cannot be started."               )\
    XX(permanent,   "Service is permanently started and can not be stopped."   )\
    XX(manual,      "Service is started and stopped manually."                 )\
    XX(immediate,   "Service is started immediately and can be stopped and "    \
                    "started manually."    )\

Map used for afw_service_startup_t enum.

Definition at line 1298 of file afw_common.h.

◆ AFW_SERVICE_STATUS_MAP

#define AFW_SERVICE_STATUS_MAP ( XX )

Value:

    XX(error,    "Service is not running because of an error."                 )\
    XX(disabled, "Service is disabled."                                        )\
    XX(ready_to_start, "Service is ready to start."                            )\
    XX(starting, "Service is starting."                                        )\
    XX(running,  "Service is running."                                         )\
    XX(stopping, "Service is finishing active work and releasing resources."   )\
    XX(stopped,  "Service is stopped and can be started manually."             )\
    XX(restarting,"Service is restarting."                                     )\

Map used for afw_service_status_t enum.

Definition at line 1321 of file afw_common.h.

◆ AFW_STACK_STRUCT

#define AFW_STACK_STRUCT	(	struct_name,
		entry_type
	)

Value:

struct struct_name { \
    union { \
        afw_stack_t pub; \
        struct { \
            const afw_pool_t *p; \
            entry_type *first; \
            entry_type *top; \
            entry_type *end; \
        }; \
    }; \
}

Define a struct for a stack with the specified entry type.

Parameters

struct_name	of struct.
entry_type	typedef name.

The member variables must correspond to afw_stack_s, but with the specified entry_type instead of void for the type of first, top, and end.

Definition at line 718 of file afw_common.h.

◆ AFW_TRUE

#define AFW_TRUE true

AFW boolean true.

True can be any value other than 0.

Only use AFW_TRUE for setting a true value. Normal C boolean testing should be used for checking.

Definition at line 383 of file afw_common.h.

◆ AFW_UTF8_FMT_ARG

#define AFW_UTF8_FMT_ARG ( A_STRING ) (int)(A_STRING)->len, (const char *)(A_STRING)->s

Convenience Macro for use with AFW_UTF8_FMT to specify arg.

Parameters

A_STRING a (const afw_utf8_t *) string.

The argument for %" AFW_UTF8_FMT " is an int length (not size_t) followed by a comma and const char *.

Definition at line 605 of file afw_common.h.

◆ AFW_UTF8_FMT_OPTIONAL_ARG

#define AFW_UTF8_FMT_OPTIONAL_ARG ( A_STRING )

Value:

(A_STRING) ? (int)(A_STRING)->len : 0, \

(A_STRING) ? (const char *)(A_STRING)->s : ""

Convenience Macro for use with AFW_UTF8_FMT to specify optional arg.

Parameters

A_STRING a (const afw_utf8_t *) string or NULL.

The argument for %" AFW_UTF8_FMT " is an int length (not size_t) followed by a comma and const char *.

Definition at line 616 of file afw_common.h.

◆ AFW_UTF8_FMT_OPTIONAL_UNDEFINED_ARG

#define AFW_UTF8_FMT_OPTIONAL_UNDEFINED_ARG ( A_STRING )

Value:

(A_STRING) ? (int)(A_STRING)->len : 0, \

(A_STRING) ? (const char *)(A_STRING)->s : "<undefined>"

Convenience Macro for use with AFW_UTF8_FMT to specify optional arg.

Parameters

A_STRING a (const afw_utf8_t *) string or undefined.

The argument for %" AFW_UTF8_FMT " is an int length (not size_t) followed by a comma and const char *. If NULL, <undefined> is supplied.

Definition at line 628 of file afw_common.h.

◆ AFW_UTF8_LITERAL

#define AFW_UTF8_LITERAL ( A_STRING ) {A_STRING, sizeof(A_STRING) - 1}

String literal initializer.

Example of use:

static const afw_utf8_t hello = AFW_UTF8_LITERAL("Hello World");

Definition at line 582 of file afw_common.h.

◆ AFW_UTF8_Z_LEN

#define AFW_UTF8_Z_LEN -1

String is NUL (0) terminate.

For function and methods that have length parameters for strings and document that -1 can be used if string is NUL (0) terminated, this symbol can be used.

Definition at line 266 of file afw_common.h.

◆ offsetof

#define offsetof	(	type,
		member
	)	__builtin_offsetof (type, member)

Todo:: FIXME:

Definition at line 135 of file afw_common.h.

Typedef Documentation

◆ afw_adaptor_id_anchor_t

typedef struct afw_adaptor_id_anchor_s afw_adaptor_id_anchor_t

Opaque typedef for afw_adaptor_id_anchor_t.

See afw_adaptor.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_adaptor_impl_request_t

typedef struct afw_adaptor_impl_request_s afw_adaptor_impl_request_t

Opaque typedef for afw_adaptor_impl_request_t.

See afw_adaptor_impl.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_adaptor_impl_session_t

typedef struct afw_adaptor_impl_session_s afw_adaptor_impl_session_t

Opaque typedef for afw_adaptor_impl_session_t.

See afw_adaptor_impl.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_adaptor_impl_t

typedef struct afw_adaptor_impl_s afw_adaptor_impl_t

Opaque typedef for afw_adaptor_impl_t.

See afw_adaptor_impl.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_adaptor_internal_cache_t

typedef struct afw_adaptor_internal_cache_s afw_adaptor_internal_cache_t

Opaque typedef for afw_adaptor_internal_cache_t.

See afw_adaptor_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_adaptor_internal_session_cache_t

typedef struct afw_adaptor_internal_session_cache_s afw_adaptor_internal_session_cache_t

Opaque typedef for afw_adaptor_internal_session_cache_t.

See afw_adaptor_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_adaptor_journal_option_t

typedef enum afw_adaptor_journal_option_e afw_adaptor_journal_option_t

Typedef for afw_adaptor_journal get_entry options enum.

The options use zero of more of these parameters:

parameter	description
entry_cursor	The objectId of a journal entry.
consumer_id	The objectId of an AdaptiveProvisioningPeer object.
limit	The maximum number of entries that will be scanned for an entry where the consumerFilter expression in the associated AdaptiveProvisioningPeer object evaluates to true.

Depending on option, get_entry() sets zero or more of these properties in the response:

property	description
entry	If a journal entry is retrieved, get_entry() will set this Object property to the entry. If the option is a "get next" option and there are no applicable entries to return, this property will remain unset.
entryCursor	If a journal entry is retrieved, get_entry() will set this Sting property to its objectId, also know as its entryCursor.
reissue	If the object retrieved is a reissue of one previously retrieved, this Boolean property will be set to true.

◆ afw_adaptor_modify_entry_t

typedef struct afw_adaptor_modify_entry_s afw_adaptor_modify_entry_t

Opaque typedef for afw_adaptor_modify_entry_t.

See afw_adaptor.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_adaptor_xctx_internal_t

typedef struct afw_adaptor_xctx_internal_s afw_adaptor_xctx_internal_t

Opaque typedef for afw_adaptor_internal_t.

See afw_adaptor_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_advice_expression_t

typedef struct afw_authorization_advice_expression_s afw_authorization_advice_expression_t

Opaque typedef for afw_authorization_advice_expression_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_combiner_parameter_t

typedef struct afw_authorization_combiner_parameter_s afw_authorization_combiner_parameter_t

Opaque typedef for afw_authorization_combiner_parameter_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_control_t

typedef struct afw_authorization_internal_control_s afw_authorization_control_t

Opaque typedef for afw_authorization_control_t.

See afw_authorization_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_decision_t

typedef struct afw_authorization_decision_s afw_authorization_decision_t

Opaque typedef for afw_authorization_decision_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_handler_id_anchor_t

typedef struct afw_authorization_internal_handler_id_anchor_s afw_authorization_handler_id_anchor_t

Opaque typedef for afw_authorization_handler_id_anchor_t.

See afw_authorization_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_handler_id_t

typedef struct afw_authorization_handler_id_s afw_authorization_handler_id_t

Opaque typedef for afw_authorization_handler_id_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_handler_impl_t

typedef struct afw_authorization_handler_impl_s afw_authorization_handler_impl_t

Opaque typedef for afw_authorization_handler_impl_t.

See afw_authorization_handler_impl.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_obligation_expression_t

typedef struct afw_authorization_obligation_expression_s afw_authorization_obligation_expression_t

Opaque typedef for afw_authorization_obligation_expression_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_policy_issuer_t

typedef struct afw_authorization_policy_issuer_s afw_authorization_policy_issuer_t

Opaque typedef for afw_authorization_policy_issuer_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_policy_location_t

typedef struct afw_authorization_policy_location_s afw_authorization_policy_location_t

Opaque typedef for afw_authorization_policy_location_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_policy_set_t

typedef struct afw_authorization_policy_set_s afw_authorization_policy_set_t

Opaque typedef for afw_authorization_policy_set_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_policy_t

typedef struct afw_authorization_policy_s afw_authorization_policy_t

Opaque typedef for afw_authorization_policy_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_authorization_rule_t

typedef struct afw_authorization_rule_s afw_authorization_rule_t

Opaque typedef for afw_authorization_rule_t.

See afw_authorization.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_boolean_t

typedef _Bool afw_boolean_t

Boolean value.

Definition at line 373 of file afw_common.h.

◆ afw_byte_t

typedef unsigned char afw_byte_t

A byte of memory (unsigned).

Definition at line 208 of file afw_common.h.

◆ afw_code_point_get_cb_t

typedef afw_code_point_t(* afw_code_point_get_cb_t) (void *data, afw_xctx_t *xctx)

Get Unicode code point callback.

Parameters

data	from provider of callback.
xctx	of caller to callback

Returns: -1 if end of file, otherwise a Unicode code point.

Definition at line 244 of file afw_common.h.

◆ afw_compile_args_t

typedef struct afw_compile_internal_args_s afw_compile_args_t

Opaque typedef for afw_compile_args_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_assignment_element_t

typedef struct afw_compile_assignment_element_s afw_compile_assignment_element_t

Opaque typedef for afw_compile_assignment_element_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_assignment_property_t

typedef struct afw_compile_internal_assignment_property_s afw_compile_assignment_property_t

Opaque typedef for afw_compile_assignment_property_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_assignment_target_t

typedef struct afw_compile_internal_assignment_target_s afw_compile_assignment_target_t

Opaque typedef for afw_compile_assignment_target_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_list_destructure_t

typedef struct afw_compile_internal_list_destructure_s afw_compile_list_destructure_t

Opaque typedef for afw_compile_list_destructure_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_object_destructure_t

typedef struct afw_compile_internal_object_destructure_s afw_compile_object_destructure_t

Opaque typedef for afw_compile_object_destructure_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_parser_t

typedef struct afw_compile_internal_parser_s afw_compile_parser_t

Opaque typedef for afw_compile_parser_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_shared_t

typedef struct afw_compile_internal_shared_s afw_compile_shared_t

Opaque typedef for afw_compile_shared_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_token_t

typedef struct afw_compile_internal_token_s afw_compile_token_t

Opaque typedef for afw_compile_token_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_type_info_t

typedef struct afw_compile_type_info_s afw_compile_type_info_t

Opaque typedef for afw_compile_type_info_t.

See afw_compile.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_compile_value_contextual_t

typedef struct afw_compile_internal_value_contextual_s afw_compile_value_contextual_t

Opaque typedef for afw_compile_value_contextual_t.

See afw_compile_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_components_t

typedef struct afw_components_s afw_components_t

Application app (afw_app) object.

See afw_components.h for more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_const_utf8_a_stack_t

typedef struct afw_const_utf8_a_stack_s afw_const_utf8_a_stack_t

Opaque typedef for afw_const_utf8_a_stack_t.

See afw_common.h for AFW_STACK_STRUCT() and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_context_cb_variable_meta_t

typedef struct afw_context_cb_variable_meta_s afw_context_cb_variable_meta_t

Opaque typedef for afw_context_cb_variable_meta_t.

See afw_context.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_context_cb_variable_t

typedef struct afw_context_cb_variable_s afw_context_cb_variable_t

Opaque typedef for afw_context_cb_variable_t.

See afw_context.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_context_t

typedef struct afw_context_s afw_context_t

Opaque typedef for afw_context_t.

See afw_context.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_dayTimeDuration_t

typedef struct afw_dayTimeDuration_s afw_dayTimeDuration_t

dayTime duration

If negative duration, all members will/MUST be negative or zero.

◆ afw_environment_conf_type_t

typedef struct afw_environment_conf_type_s afw_environment_conf_type_t

Opaque typedef for afw_environment_conf_type_t.

See afw_environment.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_environment_registry_type_t

typedef struct afw_environment_registry_type_s afw_environment_registry_type_t

Opaque typedef for afw_environment_registry_type_t.

See afw_common.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_environment_t

typedef struct afw_environment_s afw_environment_t

Opaque typedef for afw_environment_t.

See afw_interface.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_error_code_t

typedef enum afw_error_code_e afw_error_code_t

Adaptive Framework error codes enum.

◆ afw_error_context_t

typedef struct afw_error_context_s afw_error_context_t

Opaque typedef for afw_error_context_t.

See afw_error.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_error_t

typedef struct afw_error_s afw_error_t

Opaque typedef for afw_error_t.

See afw_error.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_expression_t

typedef struct afw_expression_s afw_expression_t

Opaque typedef for afw_expression_t.

See afw_expression.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_flag_t

typedef struct afw_flag_s afw_flag_t

Opaque typedef for afw_flag_t.

See afw_flag.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_function_arg_check_t

typedef const afw_utf8_t*(* afw_function_arg_check_t) (afw_function_execute_t *x, afw_size_t argc, const afw_value_t *argv[], const afw_pool_t *p, afw_xctx_t *xctx)

Typedef for function arg check functions.

Parameters

x	The function execute struct.
argc	The number of function parameters (does not include argv[0]).
argv	The function to call argv[0] followed by function parameters.
p	The memory pool allocated by the expression compiler.
xctx	of the caller.

Returns: NULL if check passed or reason if it didn't.

This function does any addition argument checking that may be needed and is only called when a expression is being compiled, NOT each time a request is processed.

Definition at line 1288 of file afw_common.h.

◆ afw_function_environment_t

typedef struct afw_function_environment_s afw_function_environment_t

Opaque typedef for afw_function_environment_t.

See afw_function.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_function_execute_cb_t

typedef const afw_value_t*(* afw_function_execute_cb_t) (afw_function_execute_t *x)

Typedef for function execute functions.

Parameters

x	Function execute struct.

Returns: (const afw_value_t *) value

Definition at line 1251 of file afw_common.h.

◆ afw_function_execute_t

typedef struct afw_function_execute_s afw_function_execute_t

Opaque typedef for afw_function_execute_t.

See afw_function.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_function_thunk_execute_t

typedef const afw_value_t*(* afw_function_thunk_execute_t) (const afw_value_function_thunk_t *function, afw_size_t argc, const afw_value_t *const *argv, const afw_pool_t *p, afw_xctx_t *xctx)

Typedef for function thunk execute functions.

Parameters

function	Evaluated argv[0] and if polymorphic, specific instance.
argc	The number of function parameters (does not include argv[0]).
argv	The function to call argv[0] followed by function parameters.
p	to use.
xctx	execution context.

Returns: (const afw_value_t *) value

Definition at line 1265 of file afw_common.h.

◆ afw_iterator_t

typedef struct afw_iterator_s afw_iterator_t

Opaque typedef iterator.

Each implementation with a afw_iterator_t ** parameter has its own private afw_iterator_s struct definition or use.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_lock_rw_t

typedef struct afw_lock_rw_s afw_lock_rw_t

Opaque typedef for afw_lock_rw_t.

See afw_lock.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_lock_t

typedef struct afw_lock_s afw_lock_t

Opaque typedef for afw_lock_t.

See afw_lock.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_log_impl_t

typedef struct afw_log_impl_s afw_log_impl_t

Opaque typedef for afw_log_impl_s.

See afw_log_impl.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_log_priority_mask_t

typedef int afw_log_priority_mask_t

Log priority mask. See afw_log.h for more information.

Definition at line 659 of file afw_common.h.

◆ afw_memory_t

typedef struct afw_memory_s afw_memory_t

Struct for memory pointer and size.

IMPORTANT: This must match up with afw_utf8_t since it is accepted to cast from afw_utf8_t to afw_memory_t. Don't cast the other way around unless you are positive ptr point to NFC Unicode – use afw_utf8_from_raw() instead.

◆ afw_model_associative_array_t

typedef struct afw_model_associative_array_s afw_model_associative_array_t

Opaque typedef for afw_model_associative_array_t.

See afw_associative_array.c for struct and more information. This is used by AFW_ASSOCIATIVE_ARRAY_TEMPLATE() in afw_model.h.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_model_internal_adaptor_self_t

typedef struct afw_model_internal_adaptor_self_s afw_model_internal_adaptor_self_t

Opaque typedef for type=model adaptor self.

See afw_model.h for struct definition.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_model_internal_adaptor_session_self_t

typedef struct afw_model_internal_adaptor_session_self_s afw_model_internal_adaptor_session_self_t

Opaque typedef for type=model adaptor session self.

See afw_model.h for struct definition.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_model_internal_context_t

typedef struct afw_model_internal_context_s afw_model_internal_context_t

Opaque typedef for afw_model_internal_context_t.

See afw_model_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_model_location_t

typedef struct afw_model_location_s afw_model_location_t

Opaque typedef for afw_model_location_t.

See afw_model_location.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_model_object_type_t

typedef struct afw_model_internal_object_type_s afw_model_object_type_t

Opaque typedef for model object type.

See afw_model.h for struct definition.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_model_property_constraint_t

typedef struct afw_model_property_constraint_s afw_model_property_constraint_t

Opaque typedef for object type property type constraint.

See afw_model.h for struct definition.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_model_property_type_t

typedef struct afw_model_internal_property_type_s afw_model_property_type_t

Opaque typedef for object type property type.

See afw_model.h for struct definition.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_model_t

typedef struct afw_model_internal_s afw_model_t

Opaque typedef for afw_model_t.

See afw_model_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_name_value_stack_t

typedef struct afw_name_value_stack_s afw_name_value_stack_t

Name/value stack.

See afw_common.h for more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_object_cb_t

typedef afw_boolean_t(* afw_object_cb_t) (const afw_object_t *object, void *context, afw_xctx_t *xctx)

Typedef for afw_adaptor_session_object callback.

Parameters

object	pointer or NULL.
context	supplied with callback
xctx	of caller

Returns: true if the callback function requests that it not be called again.

The purpose of returning true from a callback function is to short circuit a retrieve request when the callback has determined that it is "complete". Unless the callback has a special purpose like this, it should always return false so that it will continue to called until there are no more objects.

This is the callback passed to afw_adaptor_session_retrieve_objects() and afw_adaptor_session_get_object().

For afw_adaptor_session_retrieve_objects(), it is called each time an object is retrieved and once with an object pointer when finished.

For afw_adaptor_session_get_object(), it is called once, either with the object retrieved or NULL if not found.

The callback function should call afw_object_release() on object once finished with it.

Definition at line 1175 of file afw_common.h.

◆ afw_object_meta_object_t

typedef struct afw_object_meta_object_s afw_object_meta_object_t

Opaque typedef for afw_object_meta_object_t.

See afw_object_meta.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_object_meta_t

typedef struct afw_object_meta_s afw_object_meta_t

Typedef for meta variable in afw_object interface.

Information in this struct should be accessed using functions declared in afw_object_meta.h – do not access directly.

◆ afw_object_options_t

typedef struct afw_object_options_s afw_object_options_t

Object view options.

See afw_object_view.h for more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_object_path_parsed_t

typedef struct afw_object_path_parsed_s afw_object_path_parsed_t

Opaque typedef for afw_object_path_parsed_t.

See afw_object_path.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_object_path_property_name_entry_t

typedef struct afw_object_path_property_name_entry_s afw_object_path_property_name_entry_t

Opaque typedef for afw_object_path_property_name_entry_t.

See afw_object_path.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_object_properties_callback_entry_t

typedef struct afw_object_properties_callback_entry_s afw_object_properties_callback_entry_t

Opaque typedef for afw_object_properties_callback_entry_t.

See afw_object.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_object_type_property_type_t

typedef struct afw_object_type_property_type_s afw_object_type_property_type_t

Opaque typedef for afw_object_type_property_type_t.

See afw_object_type.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_object_type_t

typedef struct afw_object_type_s afw_object_type_t

Opaque typedef for afw_object_type_t.

See afw_object_type.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_octet_t

typedef unsigned char afw_octet_t

8 bits (unsigned).

Definition at line 211 of file afw_common.h.

◆ afw_pool_cleanup_function_p_t

typedef void(* afw_pool_cleanup_function_p_t) (void *data, void *data2, const afw_pool_t *p, afw_xctx_t *xctx)

Typedef for pool cleanup functions.

Parameters

data	supplied on cleanup register.
data2	supplied on cleanup register.
p	being cleaned up.
xctx	of caller to cleanup.

Definition at line 954 of file afw_common.h.

◆ afw_query_criteria_filter_entry_t

typedef struct afw_query_criteria_filter_entry_s afw_query_criteria_filter_entry_t

Opaque typedef for query criteria filter entry.

See afw_query_criteria.h for struct definition.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_query_criteria_t

typedef struct afw_query_criteria_s afw_query_criteria_t

Opaque typedef for query criteria.

See afw_query_criteria.h for struct definition.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_rc_t

typedef int afw_rc_t

Adaptive Framework Return Code.

Definition at line 663 of file afw_common.h.

◆ afw_read_cb_t

typedef afw_size_t(* afw_read_cb_t) (void *context, const void *buffer, afw_size_t size, afw_boolean_t *more_to_read, const afw_pool_t *p, afw_xctx_t *xctx)

Typedef for read callback function.

Parameters

context	supplied with callback.
buffer	where bytes will be read into.
size	is the number of bytes to read. A value of -1 reads a line.
more_to_read	indicates that there is possibly more input to read.
p	is pool to use if resources are needed.
xctx	of caller.

Returns: number of bytes read.

Definition at line 1206 of file afw_common.h.

◆ afw_runtime_const_object_instance_t

typedef struct afw_runtime_const_object_instance_s afw_runtime_const_object_instance_t

Opaque typedef for afw_runtime_const_object_instance_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_const_object_meta_object_t

typedef struct afw_runtime_const_object_meta_object_s afw_runtime_const_object_meta_object_t

Opaque typedef for afw_runtime_const_object_meta_object_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_custom_t

typedef struct afw_runtime_custom_s afw_runtime_custom_t

Opaque typedef for afw_runtime_custom_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_object_indirect_t

typedef struct afw_runtime_object_indirect_s afw_runtime_object_indirect_t

Opaque typedef for afw_runtime_object_indirect_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_object_map_property_t

typedef struct afw_runtime_object_map_property_s afw_runtime_object_map_property_t

Opaque typedef for afw_runtime_object_map_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_object_map_t

typedef struct afw_runtime_object_map_s afw_runtime_object_map_t

Opaque typedef for afw_runtime_object_map_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_object_type_meta_t

typedef struct afw_runtime_object_type_meta_s afw_runtime_object_type_meta_t

Opaque typedef for afw_runtime_object_type_meta_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_objects_t

typedef struct afw_runtime_objects_s afw_runtime_objects_t

Opaque typedef for afw_runtime_objects_t.

See afw_runtime.t for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_property_t

typedef struct afw_runtime_property_s afw_runtime_property_t

Opaque typedef for afw_runtime_property_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_unresolved_const_embedded_untyped_object_t

typedef struct afw_runtime_unresolved_const_embedded_untyped_object_s afw_runtime_unresolved_const_embedded_untyped_object_t

Opaque typedef for afw_runtime_unresolved_const_embedded_untyped_object_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_unresolved_const_list_t

typedef struct afw_runtime_unresolved_const_list_s afw_runtime_unresolved_const_list_t

Opaque typedef for afw_runtime_unresolved_const_list_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_unresolved_const_object_t

typedef struct afw_runtime_unresolved_const_object_s afw_runtime_unresolved_const_object_t

Opaque typedef for afw_runtime_unresolved_const_object_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_unresolved_property_t

typedef struct afw_runtime_unresolved_property_s afw_runtime_unresolved_property_t

Opaque typedef for afw_runtime_unresolved_property_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_runtime_unresolved_value_t

typedef struct afw_runtime_unresolved_value_s afw_runtime_unresolved_value_t

Opaque typedef for afw_runtime_unresolved_value_t.

See afw_runtime.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_service_startup_t

typedef enum afw_service_startup_e afw_service_startup_t

Typedef for service startup type enum.

This is used by the afw_service interface definition. See afw_service.h for more information.

◆ afw_service_status_t

typedef enum afw_service_status_e afw_service_status_t

Typedef for service status enum.

This is used by the afw_service interface definition. See afw_service.h for more information.

◆ afw_service_t

typedef struct afw_service_s afw_service_t

Typedef for service.

Struct defined in afw_service.h.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_service_wrapper_start_cb

typedef void(* afw_service_wrapper_start_cb) (void *data, afw_xctx_t *xctx)

Typedef for service wrapper start call back.

See afw_service.h for more information.

Definition at line 1779 of file afw_common.h.

◆ afw_service_wrapper_stop_cb

typedef void(* afw_service_wrapper_stop_cb) (void *data, afw_xctx_t *xctx)

Typedef for service wrapper stop call back.

See afw_service.h for more information.

Definition at line 1789 of file afw_common.h.

◆ afw_stack_t

typedef struct afw_stack_s afw_stack_t

Opaque typedef for afw_stack_t.

See afw_stack.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_stream_anchor_t

typedef struct afw_stream_anchor_s afw_stream_anchor_t

Typedef for stream anchor.

Struct defined in afw_stream.h.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_stream_t

typedef struct afw_stream_s afw_stream_t

Typedef for stream.

Struct defined in afw_stream.h.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_thread_mutex_t

typedef struct afw_thread_mutex_s afw_thread_mutex_t

Opaque typedef for afw_thread_mutex_t.

See afw_thread.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_thread_t

typedef struct afw_thread_s afw_thread_t

Opaque typedef for afw_thread_t.

See afw_thread.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_time_with_offset_t

typedef struct afw_time_with_offset_s afw_time_with_offset_t

Time with offset (old)

This typedef is used when time needs to be local time and a UTC offset instead of UTC time.

◆ afw_try_t

typedef struct afw_try_s afw_try_t

Opaque typedef for afw_try_t.

See afw_error.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_utf8_octet_get_cb_t

typedef int(* afw_utf8_octet_get_cb_t) (afw_utf8_octet_t *octet, void *data, afw_xctx_t *xctx)

Get an utf-8 octet (8 bits).

Parameters

octet	cursor.
data	from provider of callback.
xctx	of caller to callback

Returns: -1 if end of file, otherwise 0.

Definition at line 255 of file afw_common.h.

◆ afw_utf8_octet_t

typedef char afw_utf8_octet_t

8 bits of utf-8 codepoint.

This is one 8-bit octet of a UTF-8 encoded character.

Sting literals in c are "char *" and "NUL terminated strings" are often declared as "char *". Because of this, afw_utf8_octet_t is also "char" to avoid "differ in signedness" warnings when compiled using gcc with CFLAGS -Werror=pointer-sign active.

Depending on the compiler, "char" can be considered signed or unsigned so avoid using comparisons like (>= 0) to determine if an octet is ASCII. Even specifying "signed char" or "unsigned char" instead of "char" in gcc can cause "differ in signedness" warnings.

code point	code point	Octet 1	Octet 2	Octet 3	Octet 4
U+0000	U+007F	0xxxxxxx	-	-	-
U+0080	U+07FF	110xxxxx	10xxxxxx	-	-
U+0800	U+FFFF	1110xxxx	10xxxxxx	10xxxxxx	-
U+10000	U+10FFFF	11110xxx	10xxxxxx	10xxxxxx	10xxxxxx

Definition at line 236 of file afw_common.h.

◆ afw_utf8_stack_t

typedef struct afw_utf8_stack_s afw_utf8_stack_t

Opaque typedef for afw_const_utf8_stack_t.

See afw_common.h for AFW_STACK_STRUCT() and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_utf8_t

typedef struct afw_utf8_s afw_utf8_t

NFC normalized UTF-8 string.

IMPORTANT: This must match up with afw_utf8_t since it is accepted to cast from afw_utf8_t to afw_memory_t. Don't cast the other way around unless you are positive ptr point to NFC Unicode – use afw_utf8_from_raw() instead.

All UTF-8 strings MUST be NFC normalized. Doing otherwise can cause unintended minor or major errors.

See RFC 5198 and http://unicode.org/reports/tr15/

This string is not null terminated, so it can contain NUL characters. The number of bytes in the sting is stored in len and a pointer to the first byte in s.

See also: afw_utf8_octet_t for more information.

◆ afw_utf8_z_t

typedef afw_utf8_octet_t afw_utf8_z_t

NFC normalized UTF-8 null terminated string.

All UTF-8 strings MUST be NFC normalized. Doing otherwise can cause unintended minor or major errors.

Use the afw_utf8_z_create* functions in afw_utf8.h or an ascii literal.

If 0x00 must be represented in a string, use afw_utf8_t instead.

See also: afw_utf8_octet_t for more information.

Definition at line 523 of file afw_common.h.

◆ afw_value_annotated_t

typedef struct afw_value_annotated_s afw_value_annotated_t

Opaque typedef for afw_value_annotated_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_assignment_t

typedef struct afw_value_assignment_s afw_value_assignment_t

Opaque typedef for afw_value_assignment_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_assignment_target_t

typedef struct afw_value_assignment_target_s afw_value_assignment_target_t

Opaque typedef for afw_value_assignment_target_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_block_frame_t

typedef struct afw_value_block_frame_s afw_value_block_frame_t

Opaque typedef for afw_value_block_frame_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_block_symbol_t

typedef struct afw_value_block_symbol_s afw_value_block_symbol_t

Opaque typedef for afw_value_block_symbol_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_block_t

typedef struct afw_value_block_s afw_value_block_t

Opaque typedef for afw_value_block_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_call_args_t

typedef struct afw_value_call_args_s afw_value_call_args_t

Opaque typedef for afw_value_call_args_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_call_built_in_function_t

typedef struct afw_value_call_built_in_function_s afw_value_call_built_in_function_t

Opaque typedef for afw_value_call_built_in_function_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_call_t

typedef struct afw_value_call_s afw_value_call_t

Opaque typedef for afw_value_call_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_cb_t

typedef afw_boolean_t(* afw_value_cb_t) (const void *value, void *context, afw_xctx_t *xctx)

Typedef for value callback.

Parameters

value	void pointer or NULL.
context	supplied with callback
xctx	of caller

Returns: true if the callback function requests that it not be called again.

Definition at line 1189 of file afw_common.h.

◆ afw_value_compiled_value_t

typedef struct afw_value_internal_compiled_value_s afw_value_compiled_value_t

Opaque typedef for afw_value_compiled_value_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_compiler_listing_t

typedef struct afw_value_compiler_listing_s afw_value_compiler_listing_t

Opaque typedef for afw_value_compiler_listing_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_evaluated_t

typedef struct afw_value_evaluated_s afw_value_evaluated_t

Opaque typedef for afw_value_evaluated_t.

See afw_value.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_expression_definition_t

typedef struct afw_value_expression_definition_s afw_value_expression_definition_t

Opaque typedef for afw_value_expression_definition_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_function_definition_t

typedef struct afw_value_function_definition_s afw_value_function_definition_t

Opaque typedef for afw_value_function_definition_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_function_parameter_t

typedef struct afw_value_function_parameter_s afw_value_function_parameter_t

Opaque typedef for afw_value_function_parameter_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_function_thunk_t

typedef struct afw_value_function_thunk_s afw_value_function_thunk_t

Opaque typedef for afw_value_function_thunk_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_info_t

typedef struct afw_value_info_s afw_value_info_t

Opaque typedef for afw_value_info_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_list_expression_t

typedef struct afw_value_list_expression_s afw_value_list_expression_t

Opaque typedef for afw_value_list_expression_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_object_expression_t

typedef struct afw_value_object_expression_s afw_value_object_expression_t

Opaque typedef for afw_value_object_expression_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_qualified_variable_reference_t

typedef struct afw_value_qualified_variable_reference_s afw_value_qualified_variable_reference_t

Opaque typedef for afw_value_qualified_variable_reference_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_reference_by_key_t

typedef struct afw_value_reference_by_key_s afw_value_reference_by_key_t

Opaque typedef for afw_value_reference_by_key_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_script_function_definition_t

typedef struct afw_value_script_function_definition_s afw_value_script_function_definition_t

Opaque typedef for afw_value_script_function_definition_t.

See afw_value.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_script_function_parameter_t

typedef struct afw_value_script_function_parameter_s afw_value_script_function_parameter_t

Opaque typedef for afw_value_script_function_parameter_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_script_function_signature_t

typedef struct afw_value_script_function_signature_s afw_value_script_function_signature_t

Opaque typedef for afw_value_script_function_signature_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_template_definition_t

typedef struct afw_value_template_definition_s afw_value_template_definition_t

Opaque typedef for afw_value_template_definition_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_type_list_t

typedef struct afw_value_type_list_s afw_value_type_list_t

Opaque typedef for afw_value_type_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_type_t

typedef struct afw_value_type_s afw_value_type_t

Opaque typedef for afw_value_type_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_value_variable_reference_t

typedef struct afw_value_variable_reference_s afw_value_variable_reference_t

Opaque typedef for afw_value_variable_reference_t.

See afw_value_internal.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_write_cb_t

typedef afw_size_t(* afw_write_cb_t) (void *context, const void *buffer, afw_size_t size, const afw_pool_t *p, afw_xctx_t *xctx)

Typedef for write callback function.

Parameters

context	supplied with callback
buffer	containing bytes to written.
size	is the number of bytes to write.
p	is pool to use if resources are needed.
xctx	of caller.

Returns: number of bytes written.

Definition at line 1225 of file afw_common.h.

◆ afw_xctx_evaluation_stack_entry_t

typedef struct afw_xctx_evaluation_stack_entry_s afw_xctx_evaluation_stack_entry_t

Opaque typedef for afw_xctx_evaluation_stack_entry_t.

See afw_common.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_xctx_evaluation_stack_t

typedef struct afw_xctx_evaluation_stack_s afw_xctx_evaluation_stack_t

Opaque typedef for afw_xctx_evaluation_stack_t.

See afw_common.h for struct and more information.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_xctx_get_variable_t

typedef const afw_value_t*(* afw_xctx_get_variable_t) (const afw_xctx_qualifier_stack_entry_t *entry, const afw_utf8_t *name, afw_xctx_t *xctx)

Typedef for function to get a qualified variable.

Parameters

entry	Qualifier stack entry.
name	Name of variable.
xctx	of caller.

Returns: value or NULL if not found.

The stack is searched from newest to oldest.

Definition at line 968 of file afw_common.h.

◆ afw_xctx_qualifier_stack_entry_t

typedef struct afw_xctx_qualifier_stack_entry_s afw_xctx_qualifier_stack_entry_t

Typedef for xctx qualifier stack entry.

Struct defined in afw_xctx.h.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_xctx_qualifier_stack_t

typedef struct afw_xctx_internal_qualifier_stack_s afw_xctx_qualifier_stack_t

Typedef for xctx qualifier stack.

Struct defined in afw_xctx_internal.h.

Definition at line 1 of file afw_common_opaques.h.

◆ afw_yearMonthDuration_t

typedef struct afw_yearMonthDuration_s afw_yearMonthDuration_t

yearMonth duration

If negative duration all members will/MUST be negative or zero.

Enumeration Type Documentation

◆ afw_adaptor_journal_option_e

enum afw_adaptor_journal_option_e

Typedef for afw_adaptor_journal get_entry options enum.

The options use zero of more of these parameters:

parameter	description
entry_cursor	The objectId of a journal entry.
consumer_id	The objectId of an AdaptiveProvisioningPeer object.
limit	The maximum number of entries that will be scanned for an entry where the consumerFilter expression in the associated AdaptiveProvisioningPeer object evaluates to true.

Depending on option, get_entry() sets zero or more of these properties in the response:

property	description
entry	If a journal entry is retrieved, get_entry() will set this Object property to the entry. If the option is a "get next" option and there are no applicable entries to return, this property will remain unset.
entryCursor	If a journal entry is retrieved, get_entry() will set this Sting property to its objectId, also know as its entryCursor.
reissue	If the object retrieved is a reissue of one previously retrieved, this Boolean property will be set to true.

Enumerator
afw_adaptor_journal_option_get_first	afw_adaptor_journal get_entry option get_first Get first journal entry. Parameters entry_cursor, consumer_id, and limit are ignored. This option will set response properties "entry" and "entryCursor" if there is a first entry to return.
afw_adaptor_journal_option_get_by_cursor	afw_adaptor_journal get_entry option get_by_cursor Get journal entry specified by entry_cursor parameter. Parameters consumer_id and limit are ignored. This option will set response properties "entry" and "entryCursor" if there is an entry to retrieve. If an entry with the supplied entryCursor does not exist, a not_found error is thrown.
afw_adaptor_journal_option_get_next_after_cursor	afw_adaptor_journal get_entry option get_next_after_cursor Get the next journal entry after the one specified by the entry_cursor parameter. Parameters consumer_id and limit are ignored. This option will set response properties "entry" and "entryCursor" if there is next entry to retrieve.
afw_adaptor_journal_option_get_next_for_consumer	afw_adaptor_journal get_entry option get_next_for_consumer Get the next journal entry for a consumer referenced by the consumer_id parameter. The entry_cursor parameter is ignored. The limit parameter specifies the maximum number of entries to scan for an applicable entry for consumer before returning. This option will set response properties "entry" and "entryCursor" if an applicable entry is retrieved. Property "reissue" will be set as described below. The properties of the AdaptiveProvisioningPeer object associated with the consumer_id are used in the following way: The consumerFilter expression is used to determine if an entry is applicable. If consumeCursor property exists, return that entry at that cursor again immediately with a "reissue" property added and set to true. Journal entries are scanned beginning at the entry at the cursor in the advanceCursor property. If the advanceCursor property is not present, the scan begins after the cursor in currentCursor. If neither are present, the scan begins at the start of the journal. If an applicable entry is found, properties consumeStart and consumeCursor are set, advanceCursor is removed, and the entry is returned. Method mark_entry_consumed() will remove these properties. If no applicable entry is found, advanceCursor is set to the last entry scanned.
afw_adaptor_journal_option_get_next_for_consumer_after_cursor	afw_adaptor_journal get_entry option get_next_for_consumer_after_cursor Get the next journal entry for a consumer referenced by the consumer_id after the one specified by the entry_cursor parameter. The limit parameter specifies the maximum number of entries to scan for an applicable entry for consumer before returning. This option will set response properties "entry" and "entryCursor" if an applicable entry is retrieved. The properties of the AdaptiveProvisioningPeer object associated with the consumer_id are used in the following way: The consumerFilter expression is used to determine if an entry is applicable. Unlike option get_next_for_consumer, no other properties are referenced or modified.
afw_adaptor_journal_option_advance_cursor_for_consumer	afw_adaptor_journal get_entry option advance_cursor_for_consumer Update the advance cursor for a consumer referenced by the consumer_id parameter. The entry_cursor parameter is ignored. The limit parameter specifies the maximum number of entries to scan for an applicable entry for consumer before returning. NULL is always returned. There are no response properties set by this function. The properties of the AdaptiveProvisioningPeer object associated with the consumer_id are used in the following way: The consumerFilter expression is used to determine if an entry is applicable. Journal entries are scanned beginning at the entry at the cursor in the advanceCursor property. If the advanceCursor property is not present, the scan begins after the cursor in currentCursor. If neither are present, the scan begins at the start of the journal. If an new applicable entry is found or if the limit is met, the advanceCursor property is set to the currently scanned entry's cursor.

Definition at line 1026 of file afw_common.h.

◆ afw_error_code_e

enum afw_error_code_e

Adaptive Framework error codes enum.

Enumerator
afw_error_code_highest_afw	The Adaptive framework will not use an error code higher than this. Error codes higher than this can be assigned by users of Adaptive Framework. Use this symbol plus a value for user error codes, since its value may possibly change someday.

Definition at line 927 of file afw_common.h.

◆ afw_log_priority_e

enum afw_log_priority_e

Log levels. See afw_log.h for more information.

Enumerator
afw_log_priority_min	Invalid log level
afw_log_priority_emerg	Min syslog log priority level.
afw_log_priority_alert	System unusable
afw_log_priority_crit	Immediate action required.
afw_log_priority_err	Critical errors.
afw_log_priority_warning	Errors.
afw_log_priority_notice	Warnings.
afw_log_priority_info	Normal but significant.
afw_log_priority_debug	Informational.
afw_log_priority_max	Debug message.
afw_log_priority_trace_min	Max syslog log priority level.
afw_log_priority_trace1	Min trace priority level
afw_log_priority_trace2	Trace level 1 message.
afw_log_priority_trace3	Trace level 2 message.
afw_log_priority_trace4	Trace level 3 message.
afw_log_priority_trace5	Trace level 4 message.
afw_log_priority_trace6	Trace level 5 message.
afw_log_priority_trace7	Trace level 6 message.
afw_log_priority_trace8	Trace level 7 message.
afw_log_priority_trace_max	Trace level 8 message.

Definition at line 976 of file afw_common.h.

◆ afw_service_startup_e

enum afw_service_startup_e

Typedef for service startup type enum.

This is used by the afw_service interface definition. See afw_service.h for more information.

Definition at line 1311 of file afw_common.h.

◆ afw_service_status_e

enum afw_service_status_e

Typedef for service status enum.

This is used by the afw_service interface definition. See afw_service.h for more information.

Definition at line 1337 of file afw_common.h.

Files

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ AFW_ADAPTOR_ID

◆ AFW_ASSERT

◆ AFW_COMPILE_TYPE_MAP

◆ AFW_CRLF

◆ AFW_CRLF_STRLEN

◆ AFW_ERROR_CODE_MAP

◆ AFW_FALSE

◆ AFW_INTEGER_IS_SAFE_DOUBLE

◆ AFW_POSSIBLY_UNUSED_VARIABLE

◆ AFW_SERVICE_STARTUP_MAP

◆ AFW_SERVICE_STATUS_MAP

◆ AFW_STACK_STRUCT

◆ AFW_TRUE

◆ AFW_UTF8_FMT_ARG

◆ AFW_UTF8_FMT_OPTIONAL_ARG

◆ AFW_UTF8_FMT_OPTIONAL_UNDEFINED_ARG

◆ AFW_UTF8_LITERAL

◆ AFW_UTF8_Z_LEN

◆ offsetof

Typedef Documentation

◆ afw_adaptor_id_anchor_t

◆ afw_adaptor_impl_request_t

◆ afw_adaptor_impl_session_t

◆ afw_adaptor_impl_t

◆ afw_adaptor_internal_cache_t

◆ afw_adaptor_internal_session_cache_t

◆ afw_adaptor_journal_option_t

◆ afw_adaptor_modify_entry_t

◆ afw_adaptor_xctx_internal_t

◆ afw_authorization_advice_expression_t

◆ afw_authorization_combiner_parameter_t

◆ afw_authorization_control_t

◆ afw_authorization_decision_t

◆ afw_authorization_handler_id_anchor_t

◆ afw_authorization_handler_id_t

◆ afw_authorization_handler_impl_t

◆ afw_authorization_obligation_expression_t

◆ afw_authorization_policy_issuer_t

◆ afw_authorization_policy_location_t

◆ afw_authorization_policy_set_t

◆ afw_authorization_policy_t

◆ afw_authorization_rule_t

◆ afw_boolean_t

◆ afw_byte_t

◆ afw_code_point_get_cb_t

◆ afw_compile_args_t

◆ afw_compile_assignment_element_t

◆ afw_compile_assignment_property_t

◆ afw_compile_assignment_target_t

◆ afw_compile_list_destructure_t

◆ afw_compile_object_destructure_t

◆ afw_compile_parser_t

◆ afw_compile_shared_t

◆ afw_compile_token_t

◆ afw_compile_type_info_t

◆ afw_compile_value_contextual_t

◆ afw_components_t

◆ afw_const_utf8_a_stack_t

◆ afw_context_cb_variable_meta_t

◆ afw_context_cb_variable_t

◆ afw_context_t

◆ afw_dayTimeDuration_t

◆ afw_environment_conf_type_t

◆ afw_environment_registry_type_t

◆ afw_environment_t

◆ afw_error_code_t

◆ afw_error_context_t

◆ afw_error_t

◆ afw_expression_t

◆ afw_flag_t

◆ afw_function_arg_check_t

◆ afw_function_environment_t