Object synchronization API

Collaboration diagram for Object synchronization API:

Functions
amxs_status_t	amxs_sync_object_new (amxs_sync_object_t **object, const char *object_a, const char *object_b, int attributes, amxs_translation_cb_t translation_cb, amxs_action_cb_t action_cb, void *priv)
	Synchronization object constructor function. More...
amxs_status_t	amxs_sync_object_new_copy (amxs_sync_object_t **object, const char *object_a, const char *object_b, int attributes)
	Synchronization object constructor function. More...
void	amxs_sync_object_delete (amxs_sync_object_t **object)
	Synchronization object destructor function. More...
amxs_status_t	amxs_sync_object_add_param (amxs_sync_object_t *object, amxs_sync_param_t *param)
	Adds a synchronization parameter to a synchronization object. More...
amxs_status_t	amxs_sync_object_add_new_param (amxs_sync_object_t *object, const char *param_a, const char *param_b, int attributes, amxs_translation_cb_t translation_cb, amxs_action_cb_t action_cb, void *priv)
	Creates and adds a synchronization parameter to a synchronization object. More...
amxs_status_t	amxs_sync_object_add_new_copy_param (amxs_sync_object_t *object, const char *param_a, const char *param_b, int attributes)
	Creates and adds a synchronization parameter to a synchronization object. More...
amxs_status_t	amxs_sync_object_add_object (amxs_sync_object_t *parent, amxs_sync_object_t *child)
	Adds a synchronization object to a synchronization object. More...
amxs_status_t	amxs_sync_object_add_new_object (amxs_sync_object_t *parent, const char *object_a, const char *object_b, int attributes, amxs_translation_cb_t translation_cb, amxs_action_cb_t action_cb, void *priv)
	Creates and adds a synchronization object to a synchronization object. More...
amxs_status_t	amxs_sync_object_add_new_copy_object (amxs_sync_object_t *parent, const char *object_a, const char *object_b, int attributes)
	Creates and adds a synchronization object to a synchronization object. More...

Detailed Description

Function Documentation

amxs_sync_object_add_new_copy_object()

amxs_status_t amxs_sync_object_add_new_copy_object	(	amxs_sync_object_t *	parent,
		const char *	object_a,
		const char *	object_b,
		int	attributes
	)

Creates and adds a synchronization object to a synchronization object.

Allocates memory for a new synchronization object and initializes this object. Then adds it to the parent synchronization object.

Adding the synchronization object fails when:

• The child object was already added to the parent object.
• The child object attributes are conflicting with those of the parent object. E.g. The child object has the AMXS_SYNC_ONLY_B_TO_A attribute set, and the parent object has AMXS_SYNC_ONLY_A_TO_B set.

If the parent attributes are more strict than those of the child, the child attributes will be updated to match those of the parent.

Uses default translation amxs_sync_object_copy_trans_cb and action amxs_sync_object_copy_action_cb callbacks.

Parameters

parent	Pointer to the parent synchronization object.
object_a	Name of the object in object A
object_b	Name of the object in object B
attributes	Bitwise OR of zero or more of the following attributes: AMXS_SYNC_DEFAULT AMXS_SYNC_ONLY_B_TO_A AMXS_SYNC_ONLY_A_TO_B AMXS_SYNC_INIT_B

Returns

• amxs_status_ok: the new child object is added to the parent object
• amxs_status_duplicate: another child object with the same direction and object names already exists for the parent object
• amxs_status_invalid_attr: the attributes of the child object are conflicting with those of the parent object
• amxs_status_unknown_error: any other error

Definition at line 195 of file amxs_sync_object.c.

                                                                   {
    return amxs_sync_object_add_new_object(parent,
                                           object_a,
                                           object_b,
                                           attributes,
                                           amxs_sync_object_copy_trans_cb,
                                           amxs_sync_object_copy_action_cb,
                                           NULL);
}

amxs_sync_object_add_new_copy_param()

amxs_status_t amxs_sync_object_add_new_copy_param	(	amxs_sync_object_t *	object,
		const char *	param_a,
		const char *	param_b,
		int	attributes
	)

Creates and adds a synchronization parameter to a synchronization object.

Allocates memory for a new synchronization parameter and initializes this parameter. Then adds it to the synchronization object.

Adding the synchronization parameter fails when:

• The parameter was already added to the object.
• The parameter attributes are conflicting with those of the object. E.g. The object has the AMXS_SYNC_ONLY_B_TO_A attribute set, and the parameter has AMXS_SYNC_ONLY_A_TO_B set.

If the object attributes are more strict than those of the parameter, the parameter attributes will be updated to match those of the object.

Uses default translation amxs_sync_batch_param_copy_trans_cb and action amxs_sync_param_copy_action_cb callbacks.

Parameters

object	Pointer to a synchronization object.
param_a	Name of the parameter in object A
param_b	Name of the parameter in object B
attributes	Bitwise OR of zero or more of the following attributes: AMXS_SYNC_DEFAULT AMXS_SYNC_ONLY_B_TO_A AMXS_SYNC_ONLY_A_TO_B AMXS_SYNC_INIT_B

Returns

• amxs_status_ok: the synchronization parameter is added to the synchronization object
• amxs_status_duplicate: another synchronization parameter with the same direction and parameter names already exists for this synchronization object
• amxs_status_invalid_attr: the attributes of the synchronization parameter are conflicting with those of the synchronization object
• amxs_status_unknown_error: any other error

Definition at line 147 of file amxs_sync_object.c.

                                                                  {
    return amxs_sync_object_add_new_param(object,
                                          param_a,
                                          param_b,
                                          attributes | AMXS_SYNC_PARAM_BATCH,
                                          NULL,
                                          NULL,
                                          NULL);
}

amxs_sync_object_add_new_object()

amxs_status_t amxs_sync_object_add_new_object	(	amxs_sync_object_t *	parent,
		const char *	object_a,
		const char *	object_b,
		int	attributes,
		amxs_translation_cb_t	translation_cb,
		amxs_action_cb_t	action_cb,
		void *	priv
	)

Creates and adds a synchronization object to a synchronization object.

Allocates memory for a new synchronization object and initializes this object. Then adds it to the parent synchronization object.

Adding the synchronization object fails when:

• The child object was already added to the parent object.
• The child object attributes are conflicting with those of the parent object. E.g. The child object has the AMXS_SYNC_ONLY_B_TO_A attribute set, and the parent object has AMXS_SYNC_ONLY_A_TO_B set.

If the parent attributes are more strict than those of the child, the child attributes will be updated to match those of the parent.

Parameters

parent	Pointer to the parent synchronization object.
object_a	Name of the object in object A
object_b	Name of the object in object B
attributes	Bitwise OR of zero or more of the following attributes: AMXS_SYNC_DEFAULT AMXS_SYNC_ONLY_B_TO_A AMXS_SYNC_ONLY_A_TO_B AMXS_SYNC_INIT_B
translation_cb	Callback function to translate data coming from an object event. The output data of this function will be passed to the action callback function if this function executes succesfully. If this argument is NULL, the data from the event will be passed directly to the action callback function.
action_cb	Callback function to act on an object event.
priv	Pointer to user data which will be passed to the translation and action callbacks.

Returns

• amxs_status_ok: the new child object is added to the parent object
• amxs_status_duplicate: another child object with the same direction and object names already exists for the parent object
• amxs_status_invalid_attr: the attributes of the child object are conflicting with those of the parent object
• amxs_status_unknown_error: any other error

Definition at line 173 of file amxs_sync_object.c.

                                                          {
    amxs_status_t status = amxs_status_unknown_error;
    amxs_sync_object_t* child = NULL;
 
    status = amxs_sync_object_new(&child, object_a, object_b, attributes, translation_cb, action_cb, priv);
    when_failed(status, exit);
 
    status = amxs_sync_object_add_object(parent, child);
    if(status != amxs_status_ok) {
        amxs_sync_object_delete(&child);
    }
 
exit:
    return status;
}

amxs_sync_object_add_new_param()

amxs_status_t amxs_sync_object_add_new_param	(	amxs_sync_object_t *	object,
		const char *	param_a,
		const char *	param_b,
		int	attributes,
		amxs_translation_cb_t	translation_cb,
		amxs_action_cb_t	action_cb,
		void *	priv
	)

Creates and adds a synchronization parameter to a synchronization object.

Allocates memory for a new synchronization parameter and initializes this parameter. Then adds it to the synchronization object.

Adding the synchronization parameter fails when:

• The parameter was already added to the object.
• The parameter attributes are conflicting with those of the object. E.g. The object has the AMXS_SYNC_ONLY_B_TO_A attribute set, and the parameter has AMXS_SYNC_ONLY_A_TO_B set.

If the object attributes are more strict than those of the parameter, the parameter attributes will be updated to match those of the object.

Parameters

object	Pointer to a synchronization object.
param_a	Name of the parameter in object A
param_b	Name of the parameter in object B
attributes	Bitwise OR of zero or more of the following attributes: AMXS_SYNC_DEFAULT AMXS_SYNC_ONLY_B_TO_A AMXS_SYNC_ONLY_A_TO_B AMXS_SYNC_INIT_B
translation_cb	Callback function to translate data coming from a parameter changed event. The output data of this function will be passed to the action callback function if this function executes succesfully. If this argument is NULL, the data from the event will be passed directly to the action callback function.
action_cb	Callback function to act on a parameter changed event.
priv	Pointer to user data which will be passed to the translation and action callbacks.

Returns

• amxs_status_ok: the synchronization parameter is added to the synchronization object
• amxs_status_duplicate: another synchronization parameter with the same direction and parameter names already exists for this synchronization object
• amxs_status_invalid_attr: the attributes of the synchronization parameter are conflicting with those of the synchronization object
• amxs_status_unknown_error: any other error

Definition at line 125 of file amxs_sync_object.c.

                                                         {
    amxs_status_t status = amxs_status_unknown_error;
    amxs_sync_param_t* param = NULL;
 
    status = amxs_sync_param_new(&param, param_a, param_b, attributes, translation_cb, action_cb, priv);
    when_failed(status, exit);
 
    status = amxs_sync_object_add_param(object, param);
    if(status != amxs_status_ok) {
        amxs_sync_param_delete(&param);
    }
 
exit:
    return status;
}

amxs_sync_object_add_object()

amxs_status_t amxs_sync_object_add_object	(	amxs_sync_object_t *	parent,
		amxs_sync_object_t *	child
	)

Adds a synchronization object to a synchronization object.

The synchronization object can be be created using amxs_sync_object_new.

Adding the synchronization object fails when:

• The child object was already added to the parent object.
• The child object attributes are conflicting with those of the parent object. E.g. The child object has the AMXS_SYNC_ONLY_B_TO_A attribute set, and the parent object has AMXS_SYNC_ONLY_A_TO_B set.

If the parent attributes are more strict than those of the child, the child attributes will be updated to match those of the parent.

Parameters

parent	Pointer to the parent synchronization object.
child	Pointer to the child synchronization object.

Returns

• amxs_status_ok: the child object is added to the parent object
• amxs_status_duplicate: another child object with the same direction and object names already exists for the parent object
• amxs_status_invalid_attr: the attributes of the child object are conflicting with those of the parent object
• amxs_status_unknown_error: any other error

Definition at line 160 of file amxs_sync_object.c.

                                                                                                 {
    amxs_status_t status = amxs_status_unknown_error;
    when_null(parent, exit);
    when_null(child, exit);
    when_false_status(parent->type == amxs_sync_type_object, exit, status = amxs_status_invalid_type);
    when_false_status(child->type == amxs_sync_type_object, exit, status = amxs_status_invalid_type);
 
    status = amxs_sync_entry_add_entry(parent, child);
 
exit:
    return status;
}

amxs_sync_object_add_param()

amxs_status_t amxs_sync_object_add_param	(	amxs_sync_object_t *	object,
		amxs_sync_param_t *	param
	)

Adds a synchronization parameter to a synchronization object.

The synchronization parameter can be be created using amxs_sync_param_new.

Adding the synchronization parameter fails when:

• The parameter was already added to the object.
• The parameter attributes are conflicting with those of the object. E.g. The object has the AMXS_SYNC_ONLY_B_TO_A attribute set, and the parameter has AMXS_SYNC_ONLY_A_TO_B set.

If the object attributes are more strict than those of the parameter, the parameter attributes will be updated to match those of the object.

Parameters

object	Pointer to a synchronization object.
param	Pointer to a synchronization parameter.

Returns

• amxs_status_ok: the synchronization parameter is added to the synchronization object
• amxs_status_duplicate: another synchronization parameter with the same direction and parameter names already exists for this synchronization object
• amxs_status_invalid_attr: the attributes of the synchronization parameter are conflicting with those of the synchronization object
• amxs_status_unknown_error: any other error

Definition at line 112 of file amxs_sync_object.c.

                                                                                               {
    amxs_status_t status = amxs_status_unknown_error;
    when_null(object, exit);
    when_null(param, exit);
    when_false_status(object->type == amxs_sync_type_object, exit, status = amxs_status_invalid_type);
    when_false_status(param->type == amxs_sync_type_param, exit, status = amxs_status_invalid_type);
 
    status = amxs_sync_entry_add_entry(object, param);
 
exit:
    return status;
}

amxs_sync_object_delete()

void amxs_sync_object_delete

(

amxs_sync_object_t **

object

)

Synchronization object destructor function.

Frees all memory allocated for a synchronization object. Also removes the synchronization object from any synchronization object or context it was attached to. All attached synchronization objects and parameters will be freed as well.

Parameters

object

Pointer to a synchronization object pointer.

Definition at line 101 of file amxs_sync_object.c.

                                                          {
    when_null(object, exit);
    when_null(*object, exit);
    when_false((*object)->type == amxs_sync_type_object, exit);
 
    amxs_sync_entry_delete(object);
 
exit:
    return;
}

amxs_sync_object_new()

amxs_status_t amxs_sync_object_new	(	amxs_sync_object_t **	object,
		const char *	object_a,
		const char *	object_b,
		int	attributes,
		amxs_translation_cb_t	translation_cb,
		amxs_action_cb_t	action_cb,
		void *	priv
	)

Synchronization object constructor function.

Allocates memory for a new synchronization object and initializes this object.

Use amxs_sync_object_delete to remove the synchronization object and free all allocated memory.

Parameters

object	Pointer to a synchronization object pointer. The address of the new allocated synchronization object is stored in this pointer.
object_a	Name of the object in object A
object_b	Name of the object in object B
attributes	Bitwise OR of zero or more of the following attributes: AMXS_SYNC_DEFAULT AMXS_SYNC_ONLY_B_TO_A AMXS_SYNC_ONLY_A_TO_B AMXS_SYNC_INIT_B
translation_cb	Callback function to translate data coming from an object event. The output data of this function will be passed to the action callback function if this function executes succesfully. If this argument is NULL, the data from the event will be passed directly to the action callback function.
action_cb	Callback function to act on an object event.
priv	Pointer to user data which will be passed to the translation and action callbacks.

Returns

amxs_status_ok when the synchronization object is created, or another status code when failed to create the synchronization object.

Definition at line 71 of file amxs_sync_object.c.

                                               {
    return amxs_sync_entry_new(object,
                               object_a,
                               object_b,
                               attributes,
                               translation_cb,
                               action_cb,
                               amxs_sync_type_object,
                               priv);
}

amxs_sync_object_new_copy()

amxs_status_t amxs_sync_object_new_copy	(	amxs_sync_object_t **	object,
		const char *	object_a,
		const char *	object_b,
		int	attributes
	)

Synchronization object constructor function.

Allocates memory for a new synchronization object and initializes this object.

Use amxs_sync_object_delete to remove the synchronization object and free all allocated memory.

Uses default translation amxs_sync_object_copy_trans_cb and action amxs_sync_object_copy_action_cb callbacks.

Parameters

object	Pointer to a synchronization object pointer. The address of the new allocated synchronization object is stored in this pointer.
object_a	Name of the object in object A
object_b	Name of the object in object B
attributes	Bitwise OR of zero or more of the following attributes: AMXS_SYNC_DEFAULT AMXS_SYNC_ONLY_B_TO_A AMXS_SYNC_ONLY_A_TO_B AMXS_SYNC_INIT_B

Returns

amxs_status_ok when the synchronization object is created, or another status code when failed to create the synchronization object.

Definition at line 88 of file amxs_sync_object.c.

                                                        {
    return amxs_sync_object_new(object,
                                object_a,
                                object_b,
                                attributes,
                                amxs_sync_object_copy_trans_cb,
                                amxs_sync_object_copy_action_cb,
                                NULL);
}