Data Model Registration

Functions
int	amxb_register (amxb_bus_ctx_t *const ctx, amxd_dm_t *const dm)
	Registers a data model to a certain bus context (connection). More...

Detailed Description

Function Documentation

amxb_register()

int amxb_register	(	amxb_bus_ctx_t *const	ctx,
		amxd_dm_t *const	dm
	)

Registers a data model to a certain bus context (connection).

When a data model has been created it can be registered to one or more software busses. After registering a data model it can be accessed by other processes through that software bus system.

The bus specific back-end implementation will also take care that when objects are added or deleted, the bus system (broker/dispatcher) is updated if needed.

To unregister the data model, it is sufficient to close the connection to the bus system.

Parameters

ctx	The bus context (or connection)
dm	the data model pointer

Returns

AMXB_STATUS_OK remote function has completed successful

Definition at line 75 of file amxb_ba_register.c.

                                       {
    int retval = -1;
    const amxb_be_funcs_t* fns = NULL;
 
    when_null(ctx, exit);
    when_null(ctx->bus_ctx, exit);
    when_not_null(ctx->dm, exit);
    when_null(dm, exit);
 
    fns = ctx->bus_fn;
    if(amxb_is_valid_be_func(fns, register_dm, fns->register_dm)) {
        retval = fns->register_dm(ctx->bus_ctx, dm);
    } else {
        retval = AMXB_ERROR_NOT_SUPPORTED_OP;
    }
 
    if(retval == 0) {
        ctx->dm = dm;
    }
 
exit:
    return retval;
}