Data Model Objects MIBs

Collaboration diagram for Data Model Objects MIBs:

Functions
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...

Detailed Description

Function Documentation

amxd_object_add_mib()

amxd_status_t amxd_object_add_mib	(	amxd_object_t *const	object,
		const char *	mib_name
	)

Adds a mib to an object.

When it is possible adds a mib with the given name to an object.

When there is no mib defined with the given name this functions returns an error.

When the mib was already added to the object this function returns an error.

A mib can not be added to an object when there are name conflicts:

• when the mib contains a parameter with the same name as a parameter in the object
• when the mib contains a child object with the same name as a child object in the object
• when the mib contains a method with the same name as a method in the object

When a mib is applied to an object, the object has been extended and will contain the parameters, methods and child objects as defined in the mib.

The mib can be removed from the object using amxd_object_remove_mib

Parameters

object	the object pointer
mib_name	the mib name

Returns

Returns amxd_status_ok when the mib is applied to the object. Returns amxd_status_object_not_found when there is no mib with the given name. Returns amxd_status_duplicate when the mib can not be applied due to naming conflicts.

Definition at line 254 of file amxd_object_mib.c.

                                                        {
    amxd_status_t status = amxd_status_unknown_error;
    amxd_dm_t* dm = amxd_object_get_dm(object);
    amxd_object_t* mib = amxd_dm_get_mib(dm, mib_name);
    amxc_array_it_t* ait = NULL;
 
    when_null(dm, exit);
    when_null_status(mib, exit, status = amxd_status_object_not_found);
    if(amxd_object_has_mib(object, mib_name) ||
       !amxd_object_can_add_mib(object, mib)) {
        status = amxd_status_duplicate;
        goto exit;
    }
 
    amxd_object_copy_children(object, mib);
    amxd_object_send_add_objects(object, mib);
    amxd_object_copy_params(object, mib);
    amxd_object_copy_funcs(object, mib);
    amxd_object_copy_events(object, mib);
 
    mib_name = amxd_object_get_name(mib, AMXD_OBJECT_NAMED);
    amxd_object_send_mib(object, mib_name, true);
    ait = amxc_array_get_first_free(&object->mib_names);
    if(ait == NULL) {
        amxc_array_append_data(&object->mib_names, (void*) mib_name);
    } else {
        amxc_array_it_set_data(ait, (void*) mib_name);
    }
 
    status = amxd_status_ok;
 
exit:
    return status;
}

amxd_object_get_mibs()

char* amxd_object_get_mibs

(

amxd_object_t *

object

)

Get the names of all mibs attached to this object.

Note

Memory is allocated to store the mib names, the returned pointer must be freed. Failing to do so will result in a memory leak.

Parameters

object

the object pointer

Returns

Returns a space separated string containing the names of the mibs that are applied to this object. If no mibs are applied, returns NULL.

Definition at line 205 of file amxd_object_mib.c.

                                                  {
    char* mibs = NULL;
    amxc_array_it_t* ait = NULL;
    amxc_string_t str;
 
    amxc_string_init(&str, 0);
    when_null(object, exit);
 
    ait = amxc_array_get_first(&object->mib_names);
    while(ait != NULL) {
        const char* name = (const char*) amxc_array_it_get_data(ait);
        if(name != NULL) {
            amxc_string_appendf(&str, "%s ", name);
        }
        ait = amxc_array_it_get_next(ait);
    }
 
    amxc_string_trim(&str, NULL);
    mibs = amxc_string_take_buffer(&str);
 
exit:
    amxc_string_clean(&str);
    return mibs;
}

amxd_object_has_mib()

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.

Verifies if the mib with the given name is applied on the object

if a mib with the given name does not exists, this function returns false.

Parameters

object	the object pointer
mib_name	the mib name

Returns

Returns true if mib was set on the object, false otherwise

Definition at line 230 of file amxd_object_mib.c.

                                               {
    bool retval = false;
    amxc_array_it_t* ait = NULL;
 
    when_null(object, exit);
    when_str_empty(mib_name, exit);
 
    ait = amxc_array_get_first(&object->mib_names);
    while(ait != NULL) {
        const char* name = (const char*) amxc_array_it_get_data(ait);
        if(name != NULL) {
            if(strcmp(name, mib_name) == 0) {
                retval = true;
                break;
            }
        }
        ait = amxc_array_it_get_next(ait);
    }
 
exit:
    return retval;
}

amxd_object_remove_mib()

amxd_status_t amxd_object_remove_mib	(	amxd_object_t *const	object,
		const char *	mib_name
	)

Removes a mib from an object.

Removes a mib with the given name from the object.

Removing a mib will remove all parameters, methods and child objects from the object as defined in the mib.

All data stored in the parameters will be lost.

If there is no mib found with the given name this function returns an error.

If the mib with the given name was not set on the object, this function returns amxd_status_ok.

Parameters

object	the object pointer
mib_name	the mib name

Returns

Returns amxd_status_ok when the mib is removed from the object. Returns amxd_status_object_not_found when there is no mib with the given name.

Definition at line 290 of file amxd_object_mib.c.

                                                           {
    amxd_status_t status = amxd_status_unknown_error;
    amxd_dm_t* dm = amxd_object_get_dm(object);
    amxd_object_t* mib = amxd_dm_get_mib(dm, mib_name);
 
    when_null(dm, exit);
    when_null_status(mib, exit, status = amxd_status_object_not_found);
    when_false_status(amxd_object_has_mib(object, mib_name), exit, status = amxd_status_ok);
 
    mib_name = amxd_object_get_name(mib, AMXD_OBJECT_NAMED);
    amxd_object_send_mib(object, mib_name, false);
    amxd_object_remove_mib_params(object, mib);
    amxd_object_remove_mib_functions(object, mib);
    amxd_object_send_del_objects(object, mib);
    amxd_object_remove_mib_objects(object, mib);
    amxd_object_remove_mib_events(object, mib);
    amxd_object_clear_mib(object, mib_name);
 
    status = amxd_status_ok;
exit:
    return status;
}