Data Model

Collaboration diagram for Data Model:

Modules
	Data Model Actions

Functions
amxd_status_t	amxd_dm_new (amxd_dm_t **dm)
	Instantiate a new data model. More...
void	amxd_dm_delete (amxd_dm_t **dm)
	Deletes a data model structure. More...
amxd_status_t	amxd_dm_init (amxd_dm_t *dm)
	Initializes a data model structure. More...
void	amxd_dm_clean (amxd_dm_t *dm)
	Cleans a data model structure. More...
amxd_status_t	amxd_dm_add_root_object (amxd_dm_t *const dm, amxd_object_t *const object)
	Adds an object to the root of the data model. More...
amxd_status_t	amxd_dm_remove_root_object (amxd_dm_t *const dm, const char *name)
	Removes an object from the root of the data model. More...
amxd_object_t *	amxd_dm_get_root (amxd_dm_t *const dm)
	Fetches the root object of the data model. More...
amxd_object_t amxd_status_t amxd_status_t const char *	amxd_dm_signal_get_path (amxd_dm_t *const dm, const amxc_var_t *const signal_data)
	Get the object path from a data model signal. More...
amxd_object_t *	amxd_dm_signal_get_object (amxd_dm_t *const dm, const amxc_var_t *const signal_data)
	Get the object from a data model using the path in the recieved signal. More...

Detailed Description

Function Documentation

amxd_dm_add_root_object()

amxd_status_t amxd_dm_add_root_object	(	amxd_dm_t *const	dm,
		amxd_object_t *const	object
	)

Adds an object to the root of the data model.

A data model object can be created with amxd_object_new and added to either the data model itself using this function, or added to another object using amxd_object_add_object

Note

There is not need to keep a pointer to objects that are added to the data model, using functions amxd_object_get and amxd_object_findf it is posisble to retrieve the object pointers at any time.

Parameters

dm	the pointer to the data model structure
object	the pointer to an object

Returns

Returns amxd_status_ok if successful.

Definition at line 418 of file amxd_dm.c.

                                                                            {
    amxd_status_t retval = amxd_status_unknown_error;
 
    when_null(dm, exit);
    when_null(object, exit);
 
    retval = amxd_object_add_object(&dm->object, object);
    if(retval == 0) {
        amxd_dm_event("dm:root-added", object, NULL, false);
    }
 
exit:
    return retval;
}

amxd_dm_clean()

void amxd_dm_clean

(

amxd_dm_t *

dm

)

Cleans a data model structure.

This function frees the full data model itself. It is not needed to free all individual allocated objects that are part of the data model object hierarchy.

Parameters

dm	the pointer to the data model structure

Definition at line 365 of file amxd_dm.c.

                                  {
    when_null(dm, exit);
 
    amxd_dm_cancel_deferred(dm);
    amxd_dm_invoke_action_impl(&dm->object.cb_fns, &dm->object, NULL, action_object_destroy, NULL, NULL);
    amxd_object_clean(&dm->object);
    amxp_sigmngr_clean(&dm->sigmngr);
    amxc_llist_clean(&dm->mibs, amxd_dm_free_mib_object_it);
 
exit:
    return;
}

amxd_dm_delete()

void amxd_dm_delete

(

amxd_dm_t **

dm

)

Deletes a data model structure.

This function frees the allocated memory for the data model structure and the full data model itself. It is not needed to free all individual allocated objects that are part of the data model object hierarchy.

Note

When calling this function all store references to the data model pointer become invalid.

Parameters

dm	a pointer to the location where the pointer to the data model is store.

Definition at line 321 of file amxd_dm.c.

                                    {
    when_null(dm, exit);
    when_null((*dm), exit);
 
    amxd_dm_clean((*dm));
 
    free((*dm));
    *dm = NULL;
 
exit:
    return;
}

amxd_dm_get_root()

amxd_object_t* amxd_dm_get_root

(

amxd_dm_t *const

dm

)

Fetches the root object of the data model.

The root object has no name, it is used to add other objects to the data model using amxd_object_add_object

Parameters

dm	the pointer to the data model structure

Returns

Returns the pointer to the root object of the data model or NULL if the data model pointer (dm) is NULL.

Definition at line 456 of file amxd_dm.c.

                                                     {
    amxd_object_t* object = NULL;
 
    when_null(dm, exit);
    object = &dm->object;
 
exit:
    return object;
}

amxd_dm_init()

amxd_status_t amxd_dm_init

(

amxd_dm_t *

dm

)

Initializes a data model structure.

Typically only one data model is allocated/created for an application, preferable as a static variable, and initialized with this function

Note

To build a dynamic data model, some parts are allocated on the heap. To make sure the all allocated memory is freed, it is best to clean the created data model using amxd_dm_clean.

Parameters

dm	the pointer to the data model structure

Returns

Returns amxd_status_ok if successful.

Definition at line 334 of file amxd_dm.c.

                                          {
    amxd_status_t retval = amxd_status_unknown_error;
 
    when_null(dm, exit);
 
    amxd_init_base();
 
    when_failed(amxd_object_init(&dm->object, amxd_object_root, NULL, NULL, NULL), exit);
    when_failed(amxp_sigmngr_init(&dm->sigmngr), exit);
    when_failed(amxc_llist_init(&dm->mibs), exit);
    when_failed(amxc_llist_init(&dm->deferred), exit);
 
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:root-added"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:root-removed"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:object-added"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:object-removed"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:instance-added"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:instance-removed"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:object-changed"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:periodic-inform"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:mib-added"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "dm:mib-removed"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "app:start"), exit);
    when_failed(amxp_sigmngr_add_signal(&dm->sigmngr, "app:stop"), exit);
 
    retval = amxd_status_ok;
 
exit:
    return retval;
}

amxd_dm_new()

amxd_status_t amxd_dm_new

(

amxd_dm_t **

dm

)

Instantiate a new data model.

Allocates and initializes memory to store a data model object hierarchy. This function allocates memory from the heap,

Typically only one data model is allocated/created for an application, preferable as a static variable, see amxd_dm_init

Note

The allocated memory must be freed when not used anymore, use amxd_dm_delete to free the memory

Parameters

dm	a pointer to the location where the pointer to the new data model structure can be stored

Returns

Returns amxd_status_ok if successful.

Definition at line 306 of file amxd_dm.c.

                                          {
    amxd_status_t retval = amxd_status_unknown_error;
 
    when_null(dm, exit);
    when_not_null((*dm), exit);
 
    *dm = (amxd_dm_t*) calloc(1, sizeof(amxd_dm_t));
    when_null((*dm), exit);
 
    retval = amxd_dm_init((*dm));
 
exit:
    return retval;
}

amxd_dm_remove_root_object()

amxd_status_t amxd_dm_remove_root_object	(	amxd_dm_t *const	dm,
		const char *	name
	)

Removes an object from the root of the data model.

This function removes the object from the data model root and does delete the memory allocated for the object.

After calling this function the object is not accessible anymore.

Parameters

dm	the pointer to the data model structure
name	the name of the object

Returns

Returns amxd_status_ok if successful.

Definition at line 433 of file amxd_dm.c.

                                                                          {
    amxd_status_t retval = amxd_status_unknown_error;
    amxd_object_t* object = NULL;
    amxc_var_t data;
 
    amxc_var_init(&data);
 
    when_null(dm, exit);
    when_str_empty_status(name, exit, retval = amxd_status_invalid_name);
 
    object = amxd_object_get_child(&dm->object, name);
    when_null_status(object, exit, retval = amxd_status_object_not_found);
 
    amxd_dm_event("dm:root-removed", object, NULL, false);
 
    amxd_object_delete(&object);
 
    retval = amxd_status_ok;
exit:
    amxc_var_clean(&data);
    return retval;
}

amxd_dm_signal_get_object()

amxd_object_t* amxd_dm_signal_get_object	(	amxd_dm_t *const	dm,
		const amxc_var_t *const	signal_data
	)

Get the object from a data model using the path in the recieved signal.

The data model emits amxp signals (see libamxp) for different kind of events, like object added, object deleted, ...

Each of these events contain an object path, with this function the object referenced by the path in the signal is retrieved,

If you need the path to the object in the data model use amxd_dm_signal_get_path.

Note

• For all object deleted signals, it is not possible to retrieve the object. The object will be removed and deleted when the signal is recieved.
• To be able to get the data model signals, you need to have an event loop and connect to the signals you are interested in.

Parameters

dm	the pointer to the data model structure
signal_data	the signal data

Returns

Pointer to the data model object or NULL.

Definition at line 573 of file amxd_dm.c.

                                                                              {
    amxd_object_t* object = NULL;
    const char* path = NULL;
 
    when_null(dm, exit);
    when_null(signal_data, exit);
 
    path = amxd_dm_signal_get_path(dm, signal_data);
    when_null(path, exit);
    object = amxd_object_findf(amxd_dm_get_root(dm),
                               "%s",
                               path);
 
exit:
    return object;
}

amxd_dm_signal_get_path()

amxd_object_t amxd_status_t amxd_status_t const char* amxd_dm_signal_get_path	(	amxd_dm_t *const	dm,
		const amxc_var_t *const	signal_data
	)

Get the object path from a data model signal.

The data model emits amxp signals (see libamxp) for different kind of events, like object added, object deleted, ...

Each of these events contain an object path, with this function the path can be extracted from the signal.

If you need the pointer to the object in the data model use amxd_dm_signal_get_object.

Note

• For all object deleted signals, it is not possible to retrieve the object. The object will be removed and deleted when the signal is recieved.
• To be able to get the data model signals, you need to have an event loop and connect to the signals you are interested in.

Parameters

dm	the pointer to the data model structure
signal_data	the signal data

Returns

The path to the object, or NULL

Definition at line 560 of file amxd_dm.c.

                                                                         {
    amxc_var_t* object_path = NULL;
 
    when_null(dm, exit);
    when_null(signal_data, exit);
 
    object_path = amxc_var_get_key(signal_data, "path", 0);
 
exit:
    return amxc_var_constcast(cstring_t, object_path);
}