amxd_transaction.h File Reference

Ambiorix Data Model API header file. More...

#include <amxd/amxd_types.h>

Go to the source code of this file.

Data Structures
struct	_amxd_trans_attr
struct	_amxd_trans_action
struct	_amxd_transaction

Macros
#define	amxd_trans_set_value(type, trans, name, value)    amxd_trans_set_ ## type(trans, name, value)
	Helper macro for setting a value. More...

Typedefs
typedef enum _amxd_tattr_id	amxd_tattr_id_t
	Transaction attributes. More...
typedef struct _amxd_trans_attr	amxd_trans_attr_t
typedef struct _amxd_trans_action	amxd_trans_action_t
typedef struct _amxd_transaction	amxd_trans_t

Enumerations
enum	_amxd_tattr_id { amxd_tattr_change_ro , amxd_tattr_change_pub , amxd_tattr_change_prot , amxd_tattr_change_priv }
	Transaction attributes. More...

Functions
amxd_status_t	amxd_trans_init (amxd_trans_t *const trans)
	Initializes a transaction object. More...
void	amxd_trans_clean (amxd_trans_t *const trans)
	Cleans the transaction object. More...
amxd_status_t	amxd_trans_new (amxd_trans_t **trans)
	Allocates a transaction object on the heap and initializes it. More...
void	amxd_trans_delete (amxd_trans_t **trans)
	Frees the memory previously allocated for a transaction object. More...
amxd_status_t	amxd_trans_set_attr (amxd_trans_t *trans, amxd_tattr_id_t attr, bool enable)
	Set the transaction attributes. More...
amxd_status_t	amxd_trans_add_action (amxd_trans_t *const trans, const amxd_action_t reason, const amxc_var_t *data)
	Adds an action to a transaction. More...
amxd_status_t	amxd_trans_select_pathf (amxd_trans_t *const trans, const char *path,...) __attribute__((format(printf
	Selects an object using a absolute or relative path. More...
amxd_status_t amxd_status_t	amxd_trans_select_object (amxd_trans_t *trans, const amxd_object_t *const object)
	Selects an object using an object pointer. More...
amxd_status_t	amxd_trans_set_param (amxd_trans_t *const trans, const char *param_name, amxc_var_t *const value)
	Adds a set value action to a transaction. More...
amxd_status_t	amxd_trans_add_inst (amxd_trans_t *const trans, const uint32_t index, const char *name)
	Adds an instance add action to a transaction. More...
amxd_status_t	amxd_trans_del_inst (amxd_trans_t *const trans, const uint32_t index, const char *name)
	Adds an instance delete action to a transaction. More...
amxd_status_t	amxd_trans_add_mib (amxd_trans_t *const trans, const char *mib_name)
amxd_status_t	amxd_trans_apply (amxd_trans_t *const trans, amxd_dm_t *const dm)
	Applies all previously added actions. More...
void	amxd_trans_dump (const amxd_trans_t *const trans, const int fd, const bool reverse)
	Dumps the transaction to a file descriptor. More...
static amxd_status_t	amxd_trans_set_cstring_t (amxd_trans_t *const trans, const char *name, const char *value)
static amxd_status_t	amxd_trans_set_csv_string_t (amxd_trans_t *const trans, const char *name, const char *value)
static amxd_status_t	amxd_trans_set_ssv_string_t (amxd_trans_t *const trans, const char *name, const char *value)
static amxd_status_t	amxd_trans_set_bool (amxd_trans_t *const trans, const char *name, bool value)
static amxd_status_t	amxd_trans_set_int8_t (amxd_trans_t *const trans, const char *name, int8_t value)
static amxd_status_t	amxd_trans_set_uint8_t (amxd_trans_t *const trans, const char *name, uint8_t value)
static amxd_status_t	amxd_trans_set_int16_t (amxd_trans_t *const trans, const char *name, int16_t value)
static amxd_status_t	amxd_trans_set_uint16_t (amxd_trans_t *const trans, const char *name, uint16_t value)
static amxd_status_t	amxd_trans_set_int32_t (amxd_trans_t *const trans, const char *name, int32_t value)
static amxd_status_t	amxd_trans_set_uint32_t (amxd_trans_t *const trans, const char *name, uint32_t value)
static amxd_status_t	amxd_trans_set_int64_t (amxd_trans_t *const trans, const char *name, int64_t value)
static amxd_status_t	amxd_trans_set_uint64_t (amxd_trans_t *const trans, const char *name, uint64_t value)
static amxd_status_t	amxd_trans_set_double (amxd_trans_t *const trans, const char *name, double value)
static amxd_status_t	amxd_trans_set_amxc_ts_t (amxd_trans_t *const trans, const char *name, amxc_ts_t *value)

Detailed Description

Ambiorix Data Model API header file.

Definition in file amxd_transaction.h.

Typedef Documentation

amxd_trans_action_t

typedef struct _amxd_trans_action amxd_trans_action_t

amxd_trans_attr_t

typedef struct _amxd_trans_attr amxd_trans_attr_t

amxd_trans_t

typedef struct _amxd_transaction amxd_trans_t

Function Documentation

amxd_trans_add_mib()

amxd_status_t amxd_trans_add_mib	(	amxd_trans_t *const	trans,
		const char *	mib_name
	)

Definition at line 815 of file amxd_transaction.c.

                                                       {
    amxd_status_t status = amxd_status_unknown_error;
    amxd_trans_action_t* action = NULL;
 
    when_null(trans, exit);
 
    action = amxd_trans_new_action(trans, action_object_add_mib);
    when_null(action, exit);
    when_str_empty(mib_name, exit);
 
    when_null(amxc_var_add_key(cstring_t,
                               &action->data,
                               "mib",
                               mib_name),
              exit);
 
    status = amxd_status_ok;
 
exit:
    if(trans != NULL) {
        trans->status = status;
    }
    return status;
}

amxd_trans_set_amxc_ts_t()

static amxd_status_t amxd_trans_set_amxc_ts_t ( amxd_trans_t *const  trans, const char *  name, amxc_ts_t *  value  )

inlinestatic

Definition at line 651 of file amxd_transaction.h.

                                                         {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(amxc_ts_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_bool()

static amxd_status_t amxd_trans_set_bool ( amxd_trans_t *const  trans, const char *  name, bool  value  )

inlinestatic

Definition at line 501 of file amxd_transaction.h.

                                              {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(bool, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_cstring_t()

static amxd_status_t amxd_trans_set_cstring_t ( amxd_trans_t *const  trans, const char *  name, const char *  value  )

inlinestatic

Definition at line 456 of file amxd_transaction.h.

                                                          {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(cstring_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_csv_string_t()

static amxd_status_t amxd_trans_set_csv_string_t ( amxd_trans_t *const  trans, const char *  name, const char *  value  )

inlinestatic

Definition at line 471 of file amxd_transaction.h.

                                                             {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(csv_string_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_double()

static amxd_status_t amxd_trans_set_double ( amxd_trans_t *const  trans, const char *  name, double  value  )

inlinestatic

Definition at line 636 of file amxd_transaction.h.

                                                  {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(double, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_int16_t()

static amxd_status_t amxd_trans_set_int16_t ( amxd_trans_t *const  trans, const char *  name, int16_t  value  )

inlinestatic

Definition at line 546 of file amxd_transaction.h.

                                                    {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(int16_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_int32_t()

static amxd_status_t amxd_trans_set_int32_t ( amxd_trans_t *const  trans, const char *  name, int32_t  value  )

inlinestatic

Definition at line 576 of file amxd_transaction.h.

                                                    {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(int32_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_int64_t()

static amxd_status_t amxd_trans_set_int64_t ( amxd_trans_t *const  trans, const char *  name, int64_t  value  )

inlinestatic

Definition at line 606 of file amxd_transaction.h.

                                                    {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(int64_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_int8_t()

static amxd_status_t amxd_trans_set_int8_t ( amxd_trans_t *const  trans, const char *  name, int8_t  value  )

inlinestatic

Definition at line 516 of file amxd_transaction.h.

                                                  {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(int8_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_ssv_string_t()

static amxd_status_t amxd_trans_set_ssv_string_t ( amxd_trans_t *const  trans, const char *  name, const char *  value  )

inlinestatic

Definition at line 486 of file amxd_transaction.h.

                                                             {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(ssv_string_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_uint16_t()

static amxd_status_t amxd_trans_set_uint16_t ( amxd_trans_t *const  trans, const char *  name, uint16_t  value  )

inlinestatic

Definition at line 561 of file amxd_transaction.h.

                                                      {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(uint16_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_uint32_t()

static amxd_status_t amxd_trans_set_uint32_t ( amxd_trans_t *const  trans, const char *  name, uint32_t  value  )

inlinestatic

Definition at line 591 of file amxd_transaction.h.

                                                      {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(uint32_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_uint64_t()

static amxd_status_t amxd_trans_set_uint64_t ( amxd_trans_t *const  trans, const char *  name, uint64_t  value  )

inlinestatic

Definition at line 621 of file amxd_transaction.h.

                                                      {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(uint64_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}

amxd_trans_set_uint8_t()

static amxd_status_t amxd_trans_set_uint8_t ( amxd_trans_t *const  trans, const char *  name, uint8_t  value  )

inlinestatic

Definition at line 531 of file amxd_transaction.h.

                                                    {
    amxd_status_t status = amxd_status_unknown_error;
    amxc_var_t new_value;
 
    amxc_var_init(&new_value);
    amxc_var_set(uint8_t, &new_value, value);
    status = amxd_trans_set_param(trans, name, &new_value);
 
    amxc_var_clean(&new_value);
    return status;
}