Parameter synchronization API

Collaboration diagram for Parameter synchronization API:

Functions
amxs_status_t	amxs_sync_param_new (amxs_sync_param_t **param, const char *param_a, const char *param_b, int attributes, amxs_translation_cb_t translation_cb, amxs_action_cb_t action_cb, void *priv)
	Synchronization parameter constructor function. More...
amxs_status_t	amxs_sync_param_new_copy (amxs_sync_param_t **param, const char *param_a, const char *param_b, int attributes)
	Synchronization parameter constructor function. More...
void	amxs_sync_param_delete (amxs_sync_param_t **param)
	Synchronization parameter destructor function. More...

Detailed Description

Function Documentation

amxs_sync_param_delete()

void amxs_sync_param_delete

(

amxs_sync_param_t **

param

)

Synchronization parameter destructor function.

Frees all memory allocated for a synchronization parameter. Also removes the synchronization parameter from any synchronization object or context it was attached to.

Parameters

param

Pointer to a synchronization parameter pointer.

Definition at line 101 of file amxs_sync_param.c.

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

amxs_sync_param_new()

amxs_status_t amxs_sync_param_new	(	amxs_sync_param_t **	param,
		const char *	param_a,
		const char *	param_b,
		int	attributes,
		amxs_translation_cb_t	translation_cb,
		amxs_action_cb_t	action_cb,
		void *	priv
	)

Synchronization parameter constructor function.

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

Use amxs_sync_param_delete to remove the synchronization parameter and free all allocated memory.

Parameters

param	Pointer to a synchronization parameter pointer. The address of the new allocated synchronization parameter is stored in this pointer.
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 when the synchronization parameter is created, or another status code when failed to create the synchronization parameter.

Definition at line 70 of file amxs_sync_param.c.

                                              {
    return amxs_sync_entry_new(param,
                               param_a,
                               param_b,
                               attributes,
                               translation_cb,
                               action_cb,
                               amxs_sync_type_param,
                               priv);
}

amxs_sync_param_new_copy()

amxs_status_t amxs_sync_param_new_copy	(	amxs_sync_param_t **	param,
		const char *	param_a,
		const char *	param_b,
		int	attributes
	)

Synchronization parameter constructor function.

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

Use amxs_sync_param_delete to remove the synchronization parameter and free all allocated memory.

Uses default translation amxs_sync_param_copy_trans_cb and action amxs_sync_param_copy_action_cb callbacks.

Parameters

param	Pointer to a synchronization parameter pointer. The address of the new allocated synchronization parameter is stored in this pointer.
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 when the synchronization parameter is created, or another status code when failed to create the synchronization parameter.

Definition at line 87 of file amxs_sync_param.c.

                                                       {
    return amxs_sync_entry_new(param,
                               param_a,
                               param_b,
                               attributes,
                               amxs_sync_param_copy_trans_cb,
                               amxs_sync_param_copy_action_cb,
                               amxs_sync_type_param,
                               NULL);
}