meshx_gen_server.h File Reference

Header file for the generic server model in the BLE mesh node application. More...

#include "interface/ble_mesh/server/meshx_ble_mesh_gen_srv.h"

Include dependency graph for meshx_gen_server.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
meshx_err_t	meshx_gen_srv_send_msg_to_ble (control_task_msg_evt_to_ble_t evt, const meshx_gen_srv_cb_param_t *params)
	Sends a message to the BLE subsystem via the control task.
meshx_err_t	meshx_gen_srv_reg_cb (uint32_t model_id, meshx_server_cb cb)
	Registers a callback function for a specific generic server model.
meshx_err_t	meshx_gen_srv_dereg_cb (uint32_t model_id, meshx_server_cb cb)
	Callback function to deregister a generic server model.
meshx_err_t	meshx_gen_srv_init (void)
	Initialize the meshxuction generic server.
meshx_err_t	meshx_gen_srv_status_send (meshx_model_t *p_model, meshx_ctx_t *p_ctx, meshx_gen_srv_state_change_t state_change, size_t data_len)
	Sends a status message for the Generic Server model.

Detailed Description

Header file for the generic server model in the BLE mesh node application.

Copyright © 2024 - 2025 MeshX

This file contains the function declarations and data structures for registering, deregistering, and initializing the generic server model callbacks in the BLE mesh node application.

Definition in file meshx_gen_server.h.

Function Documentation

meshx_gen_srv_dereg_cb()

meshx_err_t meshx_gen_srv_dereg_cb	(	uint32_t	model_id,
		meshx_server_cb	cb )

Callback function to deregister a generic server model.

This function is called to deregister a generic server model identified by the given model ID.

Parameters

[in]	model_id	The ID of the model to be deregistered.
[in]	cb	The callback function to be deregistered.

Returns

• MESHX_SUCCESS: Success
• MESHX_INVALID_ARG: Invalid argument
• MESHX_FAIL: Other failures

Definition at line 148 of file meshx_gen_server.c.

{
    return control_task_msg_unsubscribe(
        CONTROL_TASK_MSG_CODE_FRM_BLE,
        model_id,
        (control_task_msg_handle_t)cb);
}

Here is the call graph for this function:

meshx_gen_srv_init()

meshx_err_t meshx_gen_srv_init

(

void

)

Initialize the meshxuction generic server.

This function sets up the necessary configurations and initializes the meshxuction generic server for the BLE mesh node.

Returns

• MESHX_SUCCESS: Success
• MESHX_FAIL: Failed to initialize the server

Definition at line 166 of file meshx_gen_server.c.

{
    if (meshx_server_init == MESHX_SERVER_INIT_MAGIC_NO)
        return MESHX_SUCCESS;
    meshx_server_init = MESHX_SERVER_INIT_MAGIC_NO;
 
    return meshx_plat_gen_srv_init();
}

Here is the call graph for this function:

meshx_gen_srv_reg_cb()

meshx_err_t meshx_gen_srv_reg_cb	(	uint32_t	model_id,
		meshx_server_cb	cb )

Registers a callback function for a specific generic server model.

This function associates a callback with the given model ID, allowing the server to handle events or messages related to that model.

Parameters

[in]	model_id	The unique identifier of the generic server model.
[in]	cb	The callback function to be registered for the model.

Returns

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

Definition at line 127 of file meshx_gen_server.c.

{
    return control_task_msg_subscribe(
        CONTROL_TASK_MSG_CODE_FRM_BLE,
        model_id,
        (control_task_msg_handle_t)cb);
}

Here is the call graph for this function:

meshx_gen_srv_send_msg_to_ble()

meshx_err_t meshx_gen_srv_send_msg_to_ble	(	control_task_msg_evt_to_ble_t	evt,
		const meshx_gen_srv_cb_param_t *	params )

Sends a message to the BLE subsystem via the control task.

This function wraps the call to control_task_msg_publish with the appropriate message code for BLE communication. It allows sending an event and associated parameters to the BLE handler.

Parameters

evt	The event type to send to BLE, of type control_task_msg_evt_to_ble_t.
params	Pointer to the parameters associated with the event.

Returns

meshx_err_t Returns the result of the message publish operation.

Definition at line 100 of file meshx_gen_server.c.

{
    if(MESHX_SUCCESS != meshx_is_status_in_gen_srv_grp(
        (uint16_t)(params->ctx.opcode)))
    {
        return MESHX_INVALID_ARG;
    }
 
    return control_task_msg_publish(CONTROL_TASK_MSG_CODE_TO_BLE,
                                    evt,
                                    params,
                                    sizeof(meshx_gen_srv_cb_param_t));
}

Here is the call graph for this function:

Here is the caller graph for this function:

meshx_gen_srv_status_send()

meshx_err_t meshx_gen_srv_status_send	(	meshx_model_t *	p_model,
		meshx_ctx_t *	p_ctx,
		meshx_gen_srv_state_change_t	state_change,
		size_t	data_len )

Sends a status message for the Generic Server model.

This function sends a status message for the Generic Server model to the BLE Mesh network. It checks if the provided model and context are valid, and if the opcode is within the range of supported Generic Server opcodes.

Parameters

[in]	p_model	Pointer to the Generic Server model structure.
[in]	p_ctx	Pointer to the context containing message information.
[in]	state_change	The state change data to be sent in the status message.
[in]	data_len	The length of the data to be sent in the status message.

Returns

• MESHX_SUCCESS: Successfully sent the status message.
• MESHX_INVALID_ARG: Invalid argument provided.
• MESHX_ERR_PLAT: Platform-specific error occurred.

Definition at line 71 of file meshx_gen_server.c.

{
    if (!p_model || !p_ctx || p_ctx->dst_addr == MESHX_ADDR_UNASSIGNED)
        return MESHX_INVALID_ARG;
    if (meshx_is_status_in_gen_srv_grp((uint16_t)p_ctx->opcode) != MESHX_SUCCESS)
        return MESHX_INVALID_ARG;
 
    return meshx_plat_gen_srv_send_status(
        p_model,
        p_ctx,
        &state_change,
        data_len
    );
}

Here is the call graph for this function: