amxd_parameter.h File Reference

#include <stdint.h>
#include <amxd/amxd_types.h>
#include <amxd/amxd_parameter_action.h>

Go to the source code of this file.

Functions
amxd_status_t	amxd_param_new (amxd_param_t **param, const char *name, const uint32_t type)
amxd_status_t	amxd_param_delete (amxd_param_t **param)
amxd_status_t	amxd_param_copy (amxd_param_t **dest, const amxd_param_t *const source)
amxd_object_t *	amxd_param_get_owner (const amxd_param_t *const param)
const char *	amxd_param_get_name (const amxd_param_t *const param)
static uint32_t	amxd_param_get_type (const amxd_param_t *const param)
amxd_status_t	amxd_param_set_attr (amxd_param_t *param, const amxd_pattr_id_t attr, const bool enable)
amxd_status_t	amxd_param_set_attrs (amxd_param_t *param, const uint32_t bitmask, bool enable)
uint32_t	amxd_param_get_attrs (const amxd_param_t *const param)
bool	amxd_param_is_attr_set (const amxd_param_t *const param, const amxd_pattr_id_t attr)
void	amxd_param_set_flag (amxd_param_t *param, const char *flag)
void	amxd_param_unset_flag (amxd_param_t *param, const char *flag)
bool	amxd_param_has_flag (const amxd_param_t *const param, const char *flag)
amxd_status_t	amxd_param_set_value (amxd_param_t *const param, const amxc_var_t *const value)
amxd_status_t	amxd_param_get_value (amxd_param_t *const param, amxc_var_t *const value)
amxd_status_t	amxd_param_validate (amxd_param_t *const param, const amxc_var_t *const value)
amxd_status_t	amxd_param_describe (amxd_param_t *const param, amxc_var_t *const value)
amxd_status_t	amxd_param_counter_update (amxd_param_t *counter)

Function Documentation

amxd_param_copy()

amxd_status_t amxd_param_copy	(	amxd_param_t **	dest,
		const amxd_param_t *const	source
	)

Definition at line 280 of file amxd_parameter.c.

                                                                {
    amxd_status_t retval = amxd_status_unknown_error;
    when_null(dest, exit);
    when_null(source, exit);
 
    *dest = (amxd_param_t*) calloc(1, sizeof(amxd_param_t));
    when_null((*dest), exit);
 
    when_failed(amxd_param_init(*dest,
                                source->name,
                                amxc_var_type_of(&source->value)),
                exit);
    (*dest)->attr = source->attr;
    amxc_var_copy(&(*dest)->value, &source->value);
    if(source->flags != NULL) {
        amxc_var_new(&(*dest)->flags);
        amxc_var_copy((*dest)->flags, source->flags);
    }
 
    retval = amxd_status_ok;
 
exit:
    if((retval != amxd_status_ok) && (dest != NULL) && (*dest != NULL)) {
        amxd_param_clean(*dest);
        free(*dest);
        *dest = NULL;
    }
    return retval;
}

amxd_param_counter_update()

amxd_status_t amxd_param_counter_update

(

amxd_param_t *

counter

)

Definition at line 209 of file amxd_parameter.c.

                                                               {
    amxd_status_t status = amxd_status_unknown_error;
    amxd_object_t* owner = NULL;
    amxd_object_t* counted = NULL;
    const char* template_path = NULL;
    amxc_var_t old_values;
 
    when_null(counter, exit);
    when_true(!amxd_param_is_attr_set(counter, amxd_pattr_counter), exit);
 
    owner = amxd_param_get_owner(counter);
    template_path = (const char*) counter->priv;
    counted = amxd_object_findf(owner, "%s", template_path);
    when_null(counted, exit);
    amxc_var_init(&old_values);
    amxc_var_set_type(&old_values, AMXC_VAR_ID_HTABLE);
    amxc_var_add_key(uint32_t,
                     &old_values,
                     amxd_param_get_name(counter),
                     GET_UINT32(&counter->value, NULL));
    amxc_var_set(uint32_t, &counter->value, amxd_object_get_instance_count(counted));
    amxd_object_send_changed(owner, &old_values, false);
    amxc_var_clean(&old_values);
 
    status = amxd_status_ok;
 
exit:
    return status;
}

amxd_param_delete()

amxd_status_t amxd_param_delete

(

amxd_param_t **

param

)

Definition at line 109 of file amxd_action_param_destroy.c.

                                                      {
    amxd_status_t status = amxd_status_unknown_error;
    amxd_object_t* object = NULL;
 
    when_null(param, exit);
    when_null(*param, exit);
    when_true_status(amxd_param_is_attr_set(*param, amxd_pattr_key) &&
                     amxd_param_get_owner(*param) != NULL,
                     exit,
                     status = amxd_status_invalid_attr);
 
    object = amxd_param_get_owner(*param);
    amxd_dm_invoke_action(object, *param, action_param_destroy, NULL, NULL);
 
    *param = NULL;
 
exit:
    return status;
}

amxd_param_describe()

amxd_status_t amxd_param_describe	(	amxd_param_t *const	param,
		amxc_var_t *const	value
	)

Definition at line 181 of file amxd_action_param_describe.c.

                                                           {
    amxd_status_t retval = amxd_status_unknown_error;
    amxd_object_t* object = NULL;
 
    when_null(param, exit);
    when_null(value, exit);
 
    object = amxd_param_get_owner(param);
    retval = amxd_dm_invoke_action(object,
                                   param,
                                   action_param_describe,
                                   NULL,
                                   value);
 
exit:
    return retval;
}

amxd_param_get_attrs()

uint32_t amxd_param_get_attrs

(

const amxd_param_t *const

param

)

Definition at line 377 of file amxd_parameter.c.

                                                               {
    uint32_t attributes = 0;
    when_null(param, exit);
 
    attributes |= param->attr.templ << amxd_pattr_template;
    attributes |= param->attr.instance << amxd_pattr_instance;
    attributes |= param->attr.priv << amxd_pattr_private;
    attributes |= param->attr.prot << amxd_pattr_protected;
    attributes |= param->attr.read_only << amxd_pattr_read_only;
    attributes |= param->attr.persistent << amxd_pattr_persistent;
    attributes |= param->attr.variable << amxd_pattr_variable;
    attributes |= param->attr.counter << amxd_pattr_counter;
    attributes |= param->attr.key << amxd_pattr_key;
    attributes |= param->attr.unique << amxd_pattr_unique;
    attributes |= param->attr.changeable << amxd_pattr_mutable;
 
exit:
    return attributes;
}

amxd_param_get_name()

const char* amxd_param_get_name

(

const amxd_param_t *const

param

)

Definition at line 322 of file amxd_parameter.c.

                                                                 {
    return param == NULL ? NULL : param->name;
}

amxd_param_get_owner()

amxd_object_t* amxd_param_get_owner

(

const amxd_param_t *const

param

)

Definition at line 311 of file amxd_parameter.c.

                                                                     {
    amxd_object_t* object = NULL;
    when_null(param, exit);
    when_null(param->it.llist, exit);
 
    object = amxc_container_of(param->it.llist, amxd_object_t, parameters);
 
exit:
    return object;
}

amxd_param_get_type()

static uint32_t amxd_param_get_type ( const amxd_param_t *const  param )

inlinestatic

Definition at line 81 of file amxd_parameter.h.

                                                              {
    return param == NULL ? AMXC_VAR_ID_NULL : amxc_var_type_of(&param->value);
}

amxd_param_get_value()

amxd_status_t amxd_param_get_value	(	amxd_param_t *const	param,
		amxc_var_t *const	value
	)

Definition at line 116 of file amxd_action_param_read.c.

                                                            {
    amxd_status_t retval = amxd_status_unknown_error;
    amxd_object_t* object = NULL;
    when_null(param, exit);
 
    object = amxd_param_get_owner(param);
 
    retval = amxd_dm_invoke_action(object, param, action_param_read, NULL, value);
 
exit:
    return retval;
}

amxd_param_has_flag()

bool amxd_param_has_flag	(	const amxd_param_t *const	param,
		const char *	flag
	)

Definition at line 433 of file amxd_parameter.c.

                                                                            {
    bool retval = false;
    when_null(param, exit);
    when_null(flag, exit);
    when_true(*flag == 0, exit);
 
    retval = amxd_common_has_flag(param->flags, flag);
 
exit:
    return retval;
}

amxd_param_is_attr_set()

bool amxd_param_is_attr_set	(	const amxd_param_t *const	param,
		const amxd_pattr_id_t	attr
	)

Definition at line 397 of file amxd_parameter.c.

                                                        {
    uint32_t flags = 0;
    bool retval = false;
    when_null(param, exit);
    when_true(attr < 0 || attr > amxd_pattr_max, exit);
 
    flags = amxd_param_get_attrs(param);
    retval = (flags & (1 << attr)) != 0 ? true : false;
 
exit:
    return retval;
}

amxd_param_new()

amxd_status_t amxd_param_new	(	amxd_param_t **	param,
		const char *	name,
		const uint32_t	type
	)

Definition at line 239 of file amxd_parameter.c.

                                                  {
 
    amxd_status_t retval = amxd_status_unknown_error;
    when_null(param, exit);
    when_true_status(!amxd_name_is_valid(name),
                     exit,
                     retval = amxd_status_invalid_name);
 
    when_true_status(!amxd_param_type_is_valid(type),
                     exit,
                     retval = amxd_status_invalid_type);
 
    *param = (amxd_param_t*) calloc(1, sizeof(amxd_param_t));
    when_null((*param), exit);
 
    retval = amxd_param_init(*param, name, type);
 
exit:
    if((retval != 0) && (param != NULL)) {
        free(*param);
        *param = NULL;
    }
    return retval;
}

amxd_param_set_attr()

amxd_status_t amxd_param_set_attr	(	amxd_param_t *	param,
		const amxd_pattr_id_t	attr,
		const bool	enable
	)

Definition at line 326 of file amxd_parameter.c.

                                                     {
    amxd_status_t retval = amxd_status_unknown_error;
    uint32_t flags = 0;
    when_null(param, exit);
    when_true_status(attr < 0 || attr > amxd_pattr_max,
                     exit,
                     retval = amxd_status_invalid_attr);
 
    flags = amxd_param_get_attrs(param);
 
    if(enable) {
        flags |= (1 << attr);
    } else {
        flags &= ~(1 << attr);
    }
 
    retval = amxd_param_set_attributes(param, flags);
 
exit:
    return retval;
}

amxd_param_set_attrs()

amxd_status_t amxd_param_set_attrs	(	amxd_param_t *	param,
		const uint32_t	bitmask,
		bool	enable
	)

Definition at line 350 of file amxd_parameter.c.

                                                {
    amxd_status_t retval = amxd_status_unknown_error;
    uint32_t flags = 0;
    uint32_t all = 0;
    for(int i = 0; i <= amxd_pattr_max; i++) {
        all |= SET_BIT(i);
    }
 
    when_null(param, exit);
    when_true_status(bitmask > all, exit, retval = amxd_status_invalid_attr);
 
    flags = amxd_param_get_attrs(param);
 
    if(enable) {
        flags |= bitmask;
    } else {
        flags &= ~bitmask;
    }
 
    retval = amxd_param_set_attributes(param, flags);
 
exit:
    return retval;
}

amxd_param_set_flag()

void amxd_param_set_flag	(	amxd_param_t *	param,
		const char *	flag
	)

Definition at line 411 of file amxd_parameter.c.

                                                                {
    when_null(param, exit);
    when_null(flag, exit);
    when_true(*flag == 0, exit);
 
    amxd_common_set_flag(&param->flags, flag);
 
exit:
    return;
}

amxd_param_set_value()

amxd_status_t amxd_param_set_value	(	amxd_param_t *const	param,
		const amxc_var_t *const	value
	)

Definition at line 113 of file amxd_action_param_write.c.

                                                                  {
    amxd_status_t retval = amxd_status_unknown_error;
    amxc_var_t backup;
    amxd_object_t* object = NULL;
    int result = 0;
    amxc_var_init(&backup);
 
    when_null(param, exit);
    retval = amxc_var_compare(value, &param->value, &result) == 0 ?
        amxd_status_ok : amxd_status_unknown_error;
    // When the value is not changed, just leave
    when_true(retval == amxd_status_ok && result == 0, exit);
 
    retval = amxd_param_validate(param, value);
    when_failed(retval, exit);
    amxc_var_copy(&backup, &param->value);
 
    object = amxd_param_get_owner(param);
    retval = amxd_dm_invoke_action(object, param, action_param_write, value, NULL);
 
exit:
    if((retval != amxd_status_ok) &&
       ( param != NULL) &&
       !amxc_var_is_null(&backup)) {
        amxc_var_copy(&param->value, &backup);
    }
    amxc_var_clean(&backup);
    return retval;
}

amxd_param_unset_flag()

void amxd_param_unset_flag	(	amxd_param_t *	param,
		const char *	flag
	)

Definition at line 422 of file amxd_parameter.c.

                                                                  {
    when_null(param, exit);
    when_null(flag, exit);
    when_true(*flag == 0, exit);
 
    amxd_common_unset_flag(&param->flags, flag);
 
exit:
    return;
}

amxd_param_validate()

amxd_status_t amxd_param_validate	(	amxd_param_t *const	param,
		const amxc_var_t *const	value
	)

Definition at line 448 of file amxd_action_param_validate.c.

                                                                 {
    amxd_status_t retval = amxd_status_unknown_error;
    amxd_object_t* object = NULL;
    when_null(param, exit);
 
    object = amxd_param_get_owner(param);
    retval = amxd_dm_invoke_action(object,
                                   param,
                                   action_param_validate,
                                   value,
                                   NULL);
 
exit:
    return retval;
}