amxd_object.h File Reference

Ambiorix Data Model API header file. More...

#include <stdint.h>
#include <amxd/amxd_types.h>
#include <amxd/amxd_common.h>
#include <amxd/amxd_object_hierarchy.h>
#include <amxd/amxd_object_function.h>
#include <amxd/amxd_object_parameter.h>
#include <amxd/amxd_object_action.h>

Go to the source code of this file.

Macros
#define	amxd_object_for_each(type, it, object)
	Helper macro for iterating object content. More...
#define	amxd_object_iterate(type, it, object)
	Helper macro for iterating object content. More...
#define	AMXD_OBJECT_NAMED   0x00
	Name and path format flag - default behavior, use name for instance objects. More...
#define	AMXD_OBJECT_INDEXED   0x01
	Name and path format flag - use index for instance objects. More...
#define	AMXD_OBJECT_EXTENDED   0x02
	Path format flag - set name or index of instrance objects between '[' and ']'. More...
#define	AMXD_OBJECT_REGEXP   0x04
	Path format flag - create path that can be used as regular expression. More...
#define	AMXD_OBJECT_TERMINATE   0x08
	Path format flag - when set the object path is terminated with a dot. More...
#define	AMXD_OBJECT_SUPPORTED   0x10
	Path format flag - adds {i} as placeholder for an instance object. More...
#define	AMXD_OBJECT_AUTO_PATH   0x20
#define	AMXD_OBJECT_PARAM   0x01
	List and describe flag. More...
#define	AMXD_OBJECT_FUNC   0x02
	List and describe flag. More...
#define	AMXD_OBJECT_CHILD   0x04
	List flag. More...
#define	AMXD_OBJECT_INSTANCE   0x08
	List flag. More...
#define	AMXD_OBJECT_NO_BASE   0x10
	List and describe flag. More...
#define	AMXD_TEMPLATE_INFO   0x20
	List and describe flag. More...
#define	AMXD_OBJECT_KEY_PARAM   0x40
#define	AMXD_OBJECT_EVENT   0x80
#define	AMXD_OBJECT_ALL
	List and describe flag. More...

Functions
amxd_status_t	amxd_object_new (amxd_object_t **object, const amxd_object_type_t type, const char *name)
	Data model object constructor function. More...
void	amxd_object_free (amxd_object_t **object)
	Data model object destructor function. More...
amxd_status_t	amxd_object_new_instance (amxd_object_t **object, amxd_object_t *templ, const char *name, uint32_t index, amxc_var_t *values)
	Data model object constructor function. More...
amxd_status_t	amxd_object_add_instance (amxd_object_t **object, amxd_object_t *templ, const char *name, uint32_t index, amxc_var_t *values)
	Data model object constructor function. More...
void	amxd_object_delete (amxd_object_t **object)
	Invokes the destroy handler(s) of the object. More...
const char *	amxd_object_get_name (const amxd_object_t *const object, const uint32_t flags)
	Get the name of the object (or index as a string for instance objects) More...
uint32_t	amxd_object_get_index (const amxd_object_t *const object)
	Get the index of an instance object. More...
static amxd_object_type_t	amxd_object_get_type (const amxd_object_t *const object)
	Returns the object type. More...
amxd_status_t	amxd_object_set_attr (amxd_object_t *const object, const amxd_oattr_id_t attr, const bool enable)
	Sets or unsets an object attribute. More...
amxd_status_t	amxd_object_set_attrs (amxd_object_t *const object, const uint32_t bitmask, bool enable)
	Sets or unsets object attributes using a bitmap. More...
uint32_t	amxd_object_get_attrs (const amxd_object_t *const object)
	Gets the set attributes of an object. More...
bool	amxd_object_is_attr_set (const amxd_object_t *const object, const amxd_oattr_id_t attr)
	Checks if an attribute is set. More...
char *	amxd_object_get_mibs (amxd_object_t *object)
	Get the names of all mibs attached to this object. More...
bool	amxd_object_has_mib (amxd_object_t *object, const char *mib_name)
	Checks if a mib has been added to a data model object. More...
amxd_status_t	amxd_object_add_mib (amxd_object_t *const object, const char *mib_name)
	Adds a mib to an object. More...
amxd_status_t	amxd_object_remove_mib (amxd_object_t *const object, const char *mib_name)
	Removes a mib from an object. More...
amxd_status_t	amxd_object_validate (amxd_object_t *const object, int32_t depth)
amxd_status_t	amxd_object_set_counter (amxd_object_t *const object, const char *name)
amxd_status_t	amxd_object_set_max_instances (amxd_object_t *object, uint32_t max)
amxd_status_t	amxd_object_list (amxd_object_t *const object, amxc_var_t *const list, uint32_t flags, amxd_dm_access_t access)
amxd_status_t	amxd_object_describe (amxd_object_t *const object, amxc_var_t *const value, uint32_t flags, amxd_dm_access_t access)
amxd_object_t *	amxd_object_get_base (const amxd_object_t *const object)
static amxc_llist_it_t *	amxd_object_first_function (const amxd_object_t *const object)
static amxc_llist_it_t *	amxd_object_first_parameter (const amxd_object_t *const object)

Detailed Description

Ambiorix Data Model API header file.

Definition in file amxd_object.h.

Macro Definition Documentation

AMXD_OBJECT_AUTO_PATH

#define AMXD_OBJECT_AUTO_PATH   0x20

Definition at line 228 of file amxd_object.h.

AMXD_OBJECT_EVENT

#define AMXD_OBJECT_EVENT   0x80

Definition at line 318 of file amxd_object.h.

AMXD_OBJECT_KEY_PARAM

#define AMXD_OBJECT_KEY_PARAM   0x40

Definition at line 316 of file amxd_object.h.

Function Documentation

amxd_object_describe()

amxd_status_t amxd_object_describe	(	amxd_object_t *const	object,
		amxc_var_t *const	value,
		uint32_t	flags,
		amxd_dm_access_t	access
	)

Definition at line 353 of file amxd_action_object_describe.c.

                                                            {
    amxd_status_t retval = amxd_status_unknown_error;
    amxc_var_t args;
 
    amxc_var_init(&args);
 
    when_null(object, exit);
    when_null(value, exit);
 
    amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
    amxc_var_add_key(bool, &args, "parameters", flags & (AMXD_OBJECT_PARAM | AMXD_OBJECT_KEY_PARAM));
    amxc_var_add_key(bool, &args, "functions", flags & AMXD_OBJECT_FUNC);
    amxc_var_add_key(bool, &args, "objects", flags & AMXD_OBJECT_CHILD);
    amxc_var_add_key(bool, &args, "instances", flags & AMXD_OBJECT_INSTANCE);
    amxc_var_add_key(bool, &args, "template_info", flags & AMXD_TEMPLATE_INFO);
    amxc_var_add_key(bool, &args, "events", flags & AMXD_OBJECT_EVENT);
    amxc_var_add_key(uint32_t, &args, "access", access);
 
    if(flags & (AMXD_OBJECT_KEY_PARAM)) {
        uint32_t attributes = flags & AMXD_OBJECT_KEY_PARAM ? SET_BIT(amxd_pattr_key) : 0;
        amxc_var_add_key(uint32_t, &args, "attributes", attributes);
    }
 
    retval = amxd_dm_invoke_action(object,
                                   NULL,
                                   action_object_describe,
                                   &args,
                                   value);
 
exit:
    amxc_var_clean(&args);
    return retval;
}

amxd_object_first_function()

static amxc_llist_it_t* amxd_object_first_function ( const amxd_object_t *const  object )

inlinestatic

Definition at line 835 of file amxd_object.h.

                                                                               {
    return object == NULL ? NULL : amxc_llist_get_first(&object->functions);
}

amxd_object_first_parameter()

static amxc_llist_it_t* amxd_object_first_parameter ( const amxd_object_t *const  object )

inlinestatic

Definition at line 840 of file amxd_object.h.

                                                                                {
    return object == NULL ? NULL : amxc_llist_get_first(&object->parameters);
}

amxd_object_get_base()

amxd_object_t* amxd_object_get_base

(

const amxd_object_t *const

object

)

Definition at line 389 of file amxd_object.c.

                                                                       {
    amxd_object_t* base = NULL;
 
    when_null(object, exit);
    when_null(object->derived_from.llist, exit);
    base = amxc_container_of(object->derived_from.llist, amxd_object_t, derived_objects);
 
exit:
    return base;
}

amxd_object_list()

amxd_status_t amxd_object_list	(	amxd_object_t *const	object,
		amxc_var_t *const	list,
		uint32_t	flags,
		amxd_dm_access_t	access
	)

Definition at line 322 of file amxd_action_object_list.c.

                                                        {
    amxd_status_t retval = amxd_status_unknown_error;
    amxc_var_t args;
 
    amxc_var_init(&args);
    when_null(object, exit);
    when_null(list, exit);
 
    amxc_var_set_type(&args, AMXC_VAR_ID_HTABLE);
    amxc_var_add_key(bool, &args, "parameters", flags & AMXD_OBJECT_PARAM);
    amxc_var_add_key(bool, &args, "functions", flags & AMXD_OBJECT_FUNC);
    amxc_var_add_key(bool, &args, "objects", flags & AMXD_OBJECT_CHILD);
    amxc_var_add_key(bool, &args, "instances", flags & AMXD_OBJECT_INSTANCE);
    amxc_var_add_key(bool, &args, "template_info", flags & AMXD_TEMPLATE_INFO);
    amxc_var_add_key(bool, &args, "events", flags & AMXD_OBJECT_EVENT);
    amxc_var_add_key(uint32_t, &args, "access", access);
    retval = amxd_dm_invoke_action(object,
                                   NULL,
                                   action_object_list,
                                   &args,
                                   list);
 
    amxc_var_clean(&args);
 
exit:
    return retval;
}

amxd_object_set_counter()

amxd_status_t amxd_object_set_counter	(	amxd_object_t *const	object,
		const char *	name
	)

Definition at line 362 of file amxd_object.c.

                                                        {
    amxd_status_t status = amxd_status_unknown_error;
    amxd_param_t* param = NULL;
    amxd_object_t* container = NULL;
 
    container = amxd_object_get_parent(object);
    when_true(!amxd_is_valid_counter(container, object), exit);
    param = amxd_create_counter_param(container, object, name);
    when_null(param, exit);
 
    if((amxd_object_get_type(container) == amxd_object_instance) ||
       (amxd_object_get_type(container) == amxd_object_singleton) ||
       (amxd_object_get_type(container) == amxd_object_template)) {
        status = amxd_status_ok;
    }
 
exit:
    if(status != amxd_status_ok) {
        if(param != NULL) {
            free(param->priv);
        }
        amxd_param_free(&param);
    }
    return status;
}

amxd_object_set_max_instances()

amxd_status_t amxd_object_set_max_instances	(	amxd_object_t *	object,
		uint32_t	max
	)

Definition at line 397 of file amxd_object_instance.c.

                                                          {
    amxd_status_t retval = amxd_status_unknown_error;
    amxc_var_t* max_var = NULL;
    uint32_t instances = 0;
    when_null(object, exit);
    when_true_status(object->type != amxd_object_template,
                     exit,
                     retval = amxd_status_invalid_type);
 
    instances = amxd_object_get_instance_count(object);
    when_true_status(max < instances, exit, retval = amxd_status_invalid_value);
 
    max_var =
        (amxc_var_t*) amxd_object_get_action_cb_data(object,
                                                     action_object_add_inst,
                                                     amxd_action_object_add_inst);
    if(max == UINT32_MAX) {
        amxd_object_remove_max_instance_check(object, max_var);
        retval = amxd_status_ok;
        goto exit;
    }
 
    if(max_var != NULL) {
        amxc_var_set(uint32_t, max_var, max);
    } else {
        retval = amxd_object_add_max_instance_check(object, max);
        when_failed(retval, exit);
    }
 
    retval = amxd_status_ok;
 
exit:
    return retval;
}

amxd_object_validate()

amxd_status_t amxd_object_validate	(	amxd_object_t *const	object,
		int32_t	depth
	)

Definition at line 132 of file amxd_action_object_validate.c.

                                                  {
    amxd_status_t status = amxd_status_ok;
 
    when_null(object, exit);
 
    amxd_object_hierarchy_walk(object,
                               amxd_direction_down,
                               amxd_object_validate_filter,
                               amxd_object_validate_impl,
                               depth,
                               &status);
 
exit:
    return status;
}