meshXBaseConfigServerModel Class Reference

Template specialization of meshXBaseServerModel for Config BLE mesh server models. More...

#include <meshx_base_model_common.hpp>

Inheritance diagram for meshXBaseConfigServerModel:

Public Member Functions
meshx_err_t	plat_model_init (void) override
	Initialize platform-specific config server model.
meshx_err_t	validate_server_status_opcode (uint16_t opcode) override
	Validate config server model status opcode.
meshx_err_t	server_state_restore (meshx_config_server_restore_params_t *param) override
	Restore server state from persistent storage.
meshx_err_t	plat_send_msg (meshx_config_server_send_params_t *params) override
	Send message through the config server model.
	meshXBaseConfigServerModel (uint32_t model_id, meshx_ptr_t p_plat_model, const control_msg_cb &from_ble_cb)
	Construct a new meshXBaseConfigServerModel object.
	meshXBaseConfigServerModel ()=delete
	Delete default constructor.
	~meshXBaseConfigServerModel () final=default
	Virtual destructor for meshXBaseConfigServerModel.
Public Member Functions inherited from meshXBaseServerModel< meshXBaseConfigServerModel, meshx_config_server_send_params_t, meshx_config_server_restore_params_t, meshx_config_srv_cb_param_t >
	meshXBaseServerModel ()=delete
virtual	~meshXBaseServerModel ()=default
meshx_err_t	from_ble_dereg_cb (void) const override
	Deregister BLE message callback for this model.
void	set_plat_model_ptr (meshx_ptr_t p_model)
	Set the platform model pointer and update the registration list.
Public Member Functions inherited from meshXBaseModel< meshx_config_server_send_params_t >
meshx_err_t	from_ble_reg_cb (void) const
	Register BLE message callback for this model.
meshx_err_t	get_status (void) const
	Get the current status of the model.
uint32_t	get_model_id (void) const
	Get the model identifier.
control_task_msg_handle_t	get_from_ble_cb (void) const
	Get the BLE message callback function.
meshXBaseModelType_t	get_model_type (void) const
	Get the model type (server/client).
void	set_status (meshx_err_t err)
	Set the model status.
void	set_model_id (uint32_t id)
	Set the model identifier.
void	set_from_ble_cb (control_task_msg_handle_t cb)
	Set the BLE message callback function.
void	set_model_type (meshXBaseModelType_t type)
	Set the model type.
	meshXBaseModel (uint32_t model_id, control_task_msg_handle_t from_ble_cb, meshXBaseModelType_t model_type)
	Construct a new meshXBaseModel object.
virtual	~meshXBaseModel ()
	Virtual destructor for meshXBaseModel.

Additional Inherited Members
Static Protected Member Functions inherited from meshXBaseServerModel< meshXBaseConfigServerModel, meshx_config_server_send_params_t, meshx_config_server_restore_params_t, meshx_config_srv_cb_param_t >
static meshx_err_t	base_from_ble_msg_handle (dev_struct_t *pdev, control_task_msg_evt_t evt, meshx_ptr_t params)
	Sends a BLE message from a server model.
Protected Attributes inherited from meshXBaseServerModel< meshXBaseConfigServerModel, meshx_config_server_send_params_t, meshx_config_server_restore_params_t, meshx_config_srv_cb_param_t >
meshx_ptr_t	p_plat_model
Protected Attributes inherited from meshXBaseModel< meshx_config_server_send_params_t >
uint32_t	model_id
meshXBaseModelType_t	model_type
control_task_msg_handle_t	from_ble_cb
meshx_err_t	status
Static Protected Attributes inherited from meshXBaseServerModel< meshXBaseConfigServerModel, meshx_config_server_send_params_t, meshx_config_server_restore_params_t, meshx_config_srv_cb_param_t >
static std::once_flag	plat_server_init_flag
static std::forward_list< base_server_model_cb_reg_t >	base_server_model_cb_list

Detailed Description

Template specialization of meshXBaseServerModel for Config BLE mesh server models.

This class provides a concrete implementation of the template-based meshXBaseServerModel specifically designed for Config BLE mesh server models. It inherits all the template benefits including type safety, static callback dispatching, and enhanced debugging while providing Config-specific functionality.

Key Features:

• Inherits template-based architecture from meshXBaseServerModel
• Provides Config-specific opcode validation and message handling
• Implements platform-specific message sending
• Supports configuration and provisioning operations
• Enhanced error handling and debugging with template type identification
• Static wrapper functions for C-style callback compatibility

Template Parameters:

• baseServerModelDerived_t: meshXBaseConfigServerModel (CRTP pattern)
• ble_mesh_send_msg_params_t: meshx_config_server_send_params_t
• ble_mesh_restore_params_t: meshx_config_server_restore_params_t

Supported Operations:

• Node identity operations
• Model composition operations
• Configuration status updates
• Provisioning-related configurations
• Device property operations
• State restoration from persistent storage

Note

This class uses private inheritance to maintain encapsulation while providing access to base functionality through friendship.

See also

meshXBaseServerModel for base template functionality.

meshx_config_server_send_params_t for send parameter structure.

meshx_config_server_restore_params_t for restore parameter structure.

Constructor & Destructor Documentation

meshXBaseConfigServerModel() [1/2]

meshXBaseConfigServerModel::meshXBaseConfigServerModel	(	uint32_t	model_id,
		meshx_ptr_t	p_plat_model,
		const control_msg_cb &	from_ble_cb )

Construct a new meshXBaseConfigServerModel object.

Parameters

[in]	model_id	Model identifier for the config server
[in]	p_plat_model	Pointer to the platform model instance
[in]	from_ble_cb	Callback function for handling BLE messages

    : meshXBaseServerModel(model_id, p_plat_model, from_ble_cb)
{
    set_status(meshXBaseConfigServerModel::plat_model_init());
    if (get_status() != MESHX_SUCCESS)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "plat_model_init failed");
        return;
    }
}

meshXBaseConfigServerModel() [2/2]

meshXBaseConfigServerModel::meshXBaseConfigServerModel ( )

delete

Delete default constructor.

~meshXBaseConfigServerModel()

meshXBaseConfigServerModel::~meshXBaseConfigServerModel ( )

finaldefault

Virtual destructor for meshXBaseConfigServerModel.

Member Function Documentation

plat_model_init()

meshx_err_t meshXBaseConfigServerModel::plat_model_init ( void )

overridevirtual

Initialize platform-specific config server model.

Returns

MESHX_SUCCESS on successful initialization, error code otherwise

Implements meshXBaseModel< meshx_config_server_send_params_t >.

{
    meshx_err_t err = MESHX_SUCCESS;
    std::call_once(plat_server_init_flag, [&]() {
        err = meshx_plat_config_srv_init();
    });
    return err;
}

plat_send_msg()

meshx_err_t meshXBaseConfigServerModel::plat_send_msg ( meshx_config_server_send_params_t * params )

overridevirtual

Send message through the config server model.

Parameters

[in]

params

Pointer to send parameters structure

Returns

MESHX_SUCCESS if message sent successfully, error code otherwise

Implements meshXBaseModel< meshx_config_server_send_params_t >.

{
    if (!params || !params->p_model || !params->p_ctx || params->p_ctx->dst_addr == MESHX_ADDR_UNASSIGNED)
    {
        return MESHX_INVALID_ARG;
    }
 
    if (validate_server_status_opcode((uint16_t)params->p_ctx->opcode) != MESHX_SUCCESS)
    {
        return MESHX_INVALID_ARG;
    }
 
    /* Platform currently doesn't provide a config-server specific "send status" helper.
     * Returning NOT_SUPPORTED so callers can handle or platform wrapper can be added.
     */
    MESHX_LOGW(MODULE_ID_MODEL_SERVER, "Config server plat_send_msg not supported on this platform");
    return MESHX_NOT_SUPPORTED;
}

server_state_restore()

meshx_err_t meshXBaseConfigServerModel::server_state_restore ( meshx_config_server_restore_params_t * param )

overridevirtual

Restore server state from persistent storage.

Parameters

[in]

param

Pointer to restoration parameters containing state data

Returns

MESHX_SUCCESS on successful restoration, error code otherwise

Implements meshXBaseServerModel< meshXBaseConfigServerModel, meshx_config_server_send_params_t, meshx_config_server_restore_params_t, meshx_config_srv_cb_param_t >.

{
    (void)param;
    /* No platform restore API exposed for config server currently. */
    return MESHX_SUCCESS;
}

validate_server_status_opcode()

meshx_err_t meshXBaseConfigServerModel::validate_server_status_opcode ( uint16_t opcode )

overridevirtual

Validate config server model status opcode.

Parameters

[in]

opcode

The opcode to validate

Returns

MESHX_SUCCESS if opcode is valid, error code otherwise

Implements meshXBaseServerModel< meshXBaseConfigServerModel, meshx_config_server_send_params_t, meshx_config_server_restore_params_t, meshx_config_srv_cb_param_t >.

{
    switch (opcode)
    {
        case MESHX_MODEL_OP_BEACON_STATUS:
        case MESHX_MODEL_OP_COMPOSITION_DATA_STATUS:
        case MESHX_MODEL_OP_DEFAULT_TTL_STATUS:
        case MESHX_MODEL_OP_GATT_PROXY_STATUS:
        case MESHX_MODEL_OP_RELAY_STATUS:
        case MESHX_MODEL_OP_MODEL_PUB_STATUS:
        case MESHX_MODEL_OP_MODEL_SUB_STATUS:
        case MESHX_MODEL_OP_SIG_MODEL_SUB_LIST:
        case MESHX_MODEL_OP_VENDOR_MODEL_SUB_LIST:
        case MESHX_MODEL_OP_NET_KEY_STATUS:
        case MESHX_MODEL_OP_NET_KEY_LIST:
        case MESHX_MODEL_OP_APP_KEY_STATUS:
        case MESHX_MODEL_OP_APP_KEY_LIST:
        case MESHX_MODEL_OP_NODE_IDENTITY_STATUS:
        case MESHX_MODEL_OP_MODEL_APP_STATUS:
        case MESHX_MODEL_OP_SIG_MODEL_APP_LIST:
        case MESHX_MODEL_OP_VENDOR_MODEL_APP_LIST:
        case MESHX_MODEL_OP_NODE_RESET_STATUS:
        case MESHX_MODEL_OP_FRIEND_STATUS:
        case MESHX_MODEL_OP_KEY_REFRESH_PHASE_STATUS:
        case MESHX_MODEL_OP_HEARTBEAT_PUB_STATUS:
        case MESHX_MODEL_OP_HEARTBEAT_SUB_STATUS:
        case MESHX_MODEL_OP_LPN_POLLTIMEOUT_STATUS:
        case MESHX_MODEL_OP_NETWORK_TRANSMIT_STATUS:
            return MESHX_SUCCESS;
        default:
            return MESHX_FAIL;
    }
}

---

The documentation for this class was generated from the following files:

• meshx_base_model_common.hpp
• meshx_base_model_common.cpp