meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t > Class Template Reference

#include <meshx_base_model_class.hpp>

Inheritance diagram for meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >:

Public Member Functions
virtual meshx_err_t	server_state_restore (ble_mesh_plat_restore_params_t *param)=0
	meshXBaseServerModel ()=delete
virtual	~meshXBaseServerModel ()=default
	meshXBaseServerModel (uint32_t model_id, meshx_ptr_t p_plat_model, const control_msg_cb &from_ble_cb)
	Constructor for the meshXBaseServerModel class.
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< ble_mesh_send_msg_params_t >
meshx_err_t	from_ble_reg_cb (void) const
	Register BLE message callback for this model.
virtual meshx_err_t	plat_model_init (void)=0
	Initialize platform model.
virtual meshx_err_t	plat_send_msg (ble_mesh_send_msg_params_t *params)=0
	Send message through the 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.
	meshXBaseModel ()=delete
virtual	~meshXBaseModel ()
	Virtual destructor for meshXBaseModel.

Protected Member Functions
virtual meshx_err_t	validate_server_status_opcode (uint16_t opcode)=0

Static Protected Member Functions
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
meshx_ptr_t	p_plat_model
Protected Attributes inherited from meshXBaseModel< ble_mesh_send_msg_params_t >
uint32_t	model_id
meshXBaseModelType_t	model_type
control_task_msg_handle_t	from_ble_cb
meshx_err_t	status = MESHX_SUCCESS

Static Protected Attributes
static std::once_flag	plat_server_init_flag
static std::forward_list< base_server_model_cb_reg_t >	base_server_model_cb_list

Private Types
using	base_server_model_cb_reg_t

Member Typedef Documentation

base_server_model_cb_reg_t

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

using meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::base_server_model_cb_reg_t

private

Initial value:

struct base_server_model_cb_reg
   {
       uint16_t model_id;   
       meshx_ptr_t p_plat_model; 
       control_msg_cb cb;   
       meshXBaseServerModel *instance; 
   }

    {
        uint16_t model_id;   /**< Model ID associated with the registration. */
        meshx_ptr_t p_plat_model; /**< Platform model pointer for instance verification. */
        control_msg_cb cb;   /**< Callback function associated with the registration. */
        meshXBaseServerModel *instance; /**< Instance pointer for registration management. */
    };

Constructor & Destructor Documentation

meshXBaseServerModel() [1/2]

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::meshXBaseServerModel ( )

delete

~meshXBaseServerModel()

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

virtual meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::~meshXBaseServerModel ( )

virtualdefault

meshXBaseServerModel() [2/2]

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::meshXBaseServerModel	(	uint32_t	model_id,
		meshx_ptr_t	p_plat_model,
		const control_msg_cb &	from_ble_cb )

Constructor for the meshXBaseServerModel class.

This constructor initializes the meshXBaseServerModel class with the given model ID and callback function.

Parameters

[in]	model_id	The unique identifier of the generic server model.
[in]	p_plat_model	Pointer to the platform-specific model structure.
[in]	from_ble_cb	The callback function to be registered for the model.

    : meshXBaseModel<ble_mesh_send_msg_params_t>(model_id, base_from_ble_msg_handle, meshXBaseModelType::MESHX_BASE_MODEL_TYPE_SERVER)
{
    this->p_plat_model = p_plat_model;
    if (!from_ble_cb)
    {
        MESHX_LOGE(MODULE_ID_MODEL_SERVER, "Invalid callback for model_id: %04x", model_id);
        this->status = MESHX_INVALID_ARG;
        return;
    }
 
    base_server_model_cb_list.push_front({(uint16_t)model_id, p_plat_model, from_ble_cb, this});
    this->status = MESHX_SUCCESS;
}

Member Function Documentation

base_from_ble_msg_handle()

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

meshx_err_t meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::base_from_ble_msg_handle ( dev_struct_t * pdev, control_task_msg_evt_t evt, meshx_ptr_t params )

staticprotected

Sends a BLE message from a server model.

Parameters

[in]	pdev	Pointer to the device structure.
[in]	evt	The event type associated with the message.
[in]	params	Pointer to the parameters of the message.

Returns

meshx_err_t Returns an error code indicating the result of the send operation.

{
    if (pdev == nullptr || params == nullptr)
        return MESHX_INVALID_ARG;
 
    auto *param = static_cast<ble_mesh_plat_cb_params_t*>(params);
    meshx_ptr_t plat_model = param->model.p_model;
 
    bool cb_invoked = false;
    for (auto &node : base_server_model_cb_list)
    {
        if ((uint16_t)evt == node.model_id)
        {
            /* Only invoke if the platform model matches this instance */
            if (node.p_plat_model != plat_model)
            {
                continue;
            }
 
            if (node.cb)
            {
                node.cb(pdev, evt, params);
                cb_invoked = true;
            }
        }
    }
 
    if (!cb_invoked)
    {
        MESHX_LOGW(MODULE_ID_MODEL_SERVER, "No registered server handled model_id=%04" PRIx32, (uint32_t)evt);
    }
 
    return cb_invoked ? MESHX_SUCCESS : MESHX_FAIL;
}

from_ble_dereg_cb()

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

meshx_err_t meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::from_ble_dereg_cb ( void ) const

overridevirtual

Deregister BLE message callback for this model.

Deregisters a callback function associated with a model ID.

Automatically called during model destruction to remove the callback function that handles BLE messages for this model's ID.

Returns

MESHX_SUCCESS if deregistration successful, error code otherwise

This function deregisters the callback function associated with the given model ID, allowing the server to stop handling events or messages related to that model.

Returns

meshx_err_t Returns an error code indicating the result of the deregistration. Possible values include success or specific error codes.

Reimplemented from meshXBaseModel< ble_mesh_send_msg_params_t >.

{
    // First, unsubscribe from control task
    meshx_err_t err = control_task_msg_unsubscribe(CONTROL_TASK_MSG_CODE_FRM_BLE, (control_task_msg_evt_t)this->model_id, this->from_ble_cb);
 
    // Then, remove from our static callback list to prevent dangling pointers
    base_server_model_cb_list.remove_if([this](const base_server_model_cb_reg_t& node) {
        return node.p_plat_model == this->p_plat_model;
    });
 
    return err;
}

server_state_restore()

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

virtual meshx_err_t meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::server_state_restore ( ble_mesh_plat_restore_params_t * param )

pure virtual

Implemented in meshXBaseConfigServerModel, meshXBaseGenericServerModel, meshXBaseLightServerModel, and meshXBaseSensorServerModel.

set_plat_model_ptr()

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

void meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::set_plat_model_ptr

(

meshx_ptr_t

p_model

)

Set the platform model pointer and update the registration list.

Parameters

[in]

p_model

Pointer to the platform model instance.

{
    this->p_plat_model = p_model;
    for (auto &node : base_server_model_cb_list)
    {
        if (node.instance == this)
        {
            node.p_plat_model = p_model;
            break;
        }
    }
}

validate_server_status_opcode()

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

virtual meshx_err_t meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::validate_server_status_opcode ( uint16_t opcode )

protectedpure virtual

Implemented in meshXBaseConfigServerModel, meshXBaseGenericServerModel, meshXBaseLightServerModel, and meshXBaseSensorServerModel.

Field Documentation

base_server_model_cb_list

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

std::forward_list<base_server_model_cb_reg_t> meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::base_server_model_cb_list

staticprotected

p_plat_model

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

meshx_ptr_t meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::p_plat_model

protected

plat_server_init_flag

template<typename baseServerModelDerived_t, typename ble_mesh_send_msg_params_t, typename ble_mesh_plat_restore_params_t, typename ble_mesh_plat_cb_params_t>

std::once_flag meshXBaseServerModel< baseServerModelDerived_t, ble_mesh_send_msg_params_t, ble_mesh_plat_restore_params_t, ble_mesh_plat_cb_params_t >::plat_server_init_flag

staticprotected

---

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

• meshx_base_model_class.hpp
• meshx_base_model_class.cpp