Bluetooth Mesh Solicitation PDU RPL Client

Data Structures
struct	bt_mesh_sol_pdu_rpl_cli
	Solicitation PDU RPL Client Model Context. More...

Macros
#define	BT_MESH_MODEL_SOL_PDU_RPL_CLI(cli_data)
	Solicitation PDU RPL Client model composition data entry.

Functions
int	bt_mesh_sol_pdu_rpl_clear (struct bt_mesh_msg_ctx *ctx, uint16_t range_start, uint8_t range_len, uint16_t *start_rsp, uint8_t *len_rsp)
	Remove entries from Solicitation PDU RPL of addresses in given range.
int	bt_mesh_sol_pdu_rpl_clear_unack (struct bt_mesh_msg_ctx *ctx, uint16_t range_start, uint8_t range_len)
	Remove entries from Solicitation PDU RPL of addresses in given range (unacked).
void	bt_mesh_sol_pdu_rpl_cli_timeout_set (int32_t timeout)
	Set the transmission timeout value.

Detailed Description

Macro Definition Documentation

BT_MESH_MODEL_SOL_PDU_RPL_CLI

#define BT_MESH_MODEL_SOL_PDU_RPL_CLI

(

cli_data

)

#include <include/zephyr/bluetooth/mesh/sol_pdu_rpl_cli.h>

Value:

        BT_MESH_MODEL_CB(BT_MESH_MODEL_ID_SOL_PDU_RPL_CLI,                  \
                         _bt_mesh_sol_pdu_rpl_cli_op, NULL, cli_data,       \
                         &_bt_mesh_sol_pdu_rpl_cli_cb)

Solicitation PDU RPL Client model composition data entry.

Function Documentation

bt_mesh_sol_pdu_rpl_clear()

int bt_mesh_sol_pdu_rpl_clear	(	struct bt_mesh_msg_ctx *	ctx,
		uint16_t	range_start,
		uint8_t	range_len,
		uint16_t *	start_rsp,
		uint8_t *	len_rsp
	)

#include <include/zephyr/bluetooth/mesh/sol_pdu_rpl_cli.h>

Remove entries from Solicitation PDU RPL of addresses in given range.

This method can be used asynchronously by setting start_rsp or len_rsp as NULL. This way the method will not wait for response and will return immediately after sending the command.

To process the response arguments of an async method, register the srpl_status callback in bt_mesh_sol_pdu_rpl_cli struct.

Parameters

ctx	Message context for the message.
range_start	Start of Unicast address range.
range_len	Length of Unicast address range. Valid values are 0x00 and 0x02 to 0xff.
start_rsp	Range start response buffer.
len_rsp	Range length response buffer.

Returns

0 on success, or (negative) error code otherwise.

bt_mesh_sol_pdu_rpl_clear_unack()

int bt_mesh_sol_pdu_rpl_clear_unack	(	struct bt_mesh_msg_ctx *	ctx,
		uint16_t	range_start,
		uint8_t	range_len
	)

#include <include/zephyr/bluetooth/mesh/sol_pdu_rpl_cli.h>

Remove entries from Solicitation PDU RPL of addresses in given range (unacked).

Parameters

ctx	Message context for the message.
range_start	Start of Unicast address range.
range_len	Length of Unicast address range. Valid values are 0x00 and 0x02 to 0xff.

Returns

0 on success, or (negative) error code otherwise.

bt_mesh_sol_pdu_rpl_cli_timeout_set()

void bt_mesh_sol_pdu_rpl_cli_timeout_set

(

int32_t

timeout

)

#include <include/zephyr/bluetooth/mesh/sol_pdu_rpl_cli.h>

Set the transmission timeout value.

Parameters

timeout

The new transmission timeout in milliseconds.