amxs_types.h File Reference

Ambiorix Object Synchronization API header file. More...

#include <amxp/amxp_signal.h>
#include <amxp/amxp_slot.h>
#include <amxd/amxd_types.h>
#include <amxb/amxb.h>

Go to the source code of this file.

Data Structures
struct	_amxs_sync_entry

Macros
#define	AMXS_SYNC_DEFAULT   0x00
	Default synchronization attributes. More...
#define	AMXS_SYNC_ONLY_B_TO_A   0x01
	Only synchronize from object B to object A. More...
#define	AMXS_SYNC_ONLY_A_TO_B   0x02
	Only synchronize from object A to object B. More...
#define	AMXS_SYNC_INIT_B   0x04
	Take the initial values from object B. More...
#define	AMXS_SYNC_PARAM_BATCH   0x08
	Indicate that this parameter may be part of a batch copy operation. More...

Typedefs
typedef enum _amxs_sync_direction	amxs_sync_direction_t
typedef enum _amxs_status	amxs_status_t
typedef enum _amxs_sync_entry_type	amxs_sync_entry_type_t
typedef struct _amxs_sync_entry	amxs_sync_ctx_t
typedef struct _amxs_sync_entry	amxs_sync_object_t
typedef struct _amxs_sync_entry	amxs_sync_param_t
typedef struct _amxs_sync_entry	amxs_sync_entry_t
typedef amxs_status_t(*	amxs_translation_cb_t) (const amxs_sync_entry_t *entry, amxs_sync_direction_t direction, const amxc_var_t *input, amxc_var_t *output, void *priv)
	Definition of the translation callback function. More...
typedef amxs_status_t(*	amxs_action_cb_t) (const amxs_sync_entry_t *entry, amxs_sync_direction_t direction, amxc_var_t *data, void *priv)
	Definition of the action callback function. More...

Enumerations
enum	_amxs_sync_direction { amxs_sync_a_to_b , amxs_sync_b_to_a , amxs_sync_invalid }
enum	_amxs_status {   amxs_status_ok , amxs_status_duplicate , amxs_status_invalid_attr , amxs_status_invalid_arg ,   amxs_status_unknown_error , amxs_status_empty_context , amxs_status_invalid_type , amxs_status_object_not_found ,   amxs_status_subscription_failed , amxs_status_last }
enum	_amxs_sync_entry_type { amxs_sync_type_invalid , amxs_sync_type_ctx , amxs_sync_type_object , amxs_sync_type_param }

Detailed Description

Ambiorix Object Synchronization API header file.

Definition in file amxs_types.h.

Typedef Documentation

amxs_status_t

typedef enum _amxs_status amxs_status_t

amxs_sync_ctx_t

typedef struct _amxs_sync_entry amxs_sync_ctx_t

Definition at line 1 of file amxs_types.h.

amxs_sync_direction_t

typedef enum _amxs_sync_direction amxs_sync_direction_t

amxs_sync_entry_t

typedef struct _amxs_sync_entry amxs_sync_entry_t

Definition at line 1 of file amxs_types.h.

amxs_sync_entry_type_t

typedef enum _amxs_sync_entry_type amxs_sync_entry_type_t

amxs_sync_object_t

typedef struct _amxs_sync_entry amxs_sync_object_t

Definition at line 1 of file amxs_types.h.

amxs_sync_param_t

typedef struct _amxs_sync_entry amxs_sync_param_t

Definition at line 1 of file amxs_types.h.

Enumeration Type Documentation

_amxs_status

enum _amxs_status

Enumerator
amxs_status_ok
amxs_status_duplicate
amxs_status_invalid_attr
amxs_status_invalid_arg
amxs_status_unknown_error
amxs_status_empty_context
amxs_status_invalid_type
amxs_status_object_not_found
amxs_status_subscription_failed
amxs_status_last

Definition at line 85 of file amxs_types.h.

                          {
    amxs_status_ok,
    amxs_status_duplicate,
    amxs_status_invalid_attr,
    amxs_status_invalid_arg,
    amxs_status_unknown_error,
    amxs_status_empty_context,
    amxs_status_invalid_type,
    amxs_status_object_not_found,
    amxs_status_subscription_failed,
    amxs_status_last
} amxs_status_t;

_amxs_sync_direction

enum _amxs_sync_direction

Enumerator
amxs_sync_a_to_b
amxs_sync_b_to_a
amxs_sync_invalid

Definition at line 79 of file amxs_types.h.

                                  {
    amxs_sync_a_to_b,
    amxs_sync_b_to_a,
    amxs_sync_invalid
} amxs_sync_direction_t;

_amxs_sync_entry_type

enum _amxs_sync_entry_type

Enumerator
amxs_sync_type_invalid
amxs_sync_type_ctx
amxs_sync_type_object
amxs_sync_type_param

Definition at line 98 of file amxs_types.h.

                                   {
    amxs_sync_type_invalid,
    amxs_sync_type_ctx,
    amxs_sync_type_object,
    amxs_sync_type_param
} amxs_sync_entry_type_t;