nRF5 SDK for Mesh v2.2.0
Data Fields
nrf_mesh_tx_params_t Struct Reference

Mesh packet transmission parameters. More...

#include <nrf_mesh.h>

Data Fields

nrf_mesh_address_t dst
 Packet destination address. More...
 
uint16_t src
 Address of the element the packet originates from (must be a unicast address). More...
 
uint8_t ttl
 Time to live value for the packet, this is a 7 bit value. More...
 
bool force_segmented
 See Section 3.7.5.2 in the Mesh Profile Specification v1.0. More...
 
nrf_mesh_transmic_size_t transmic_size
 Transport MIC Size selection.
 
const uint8_t * p_data
 Points to the payload to be sent. More...
 
uint16_t data_len
 Length of the payload being sent. More...
 
nrf_mesh_secmat_t security_material
 Required for encryption. More...
 
nrf_mesh_tx_token_t tx_token
 Token that can be used as a reference in the TX complete callback. More...
 

Detailed Description

Mesh packet transmission parameters.

Note
If the length of the message is greater than NRF_MESH_UNSEG_PAYLOAD_SIZE_MAX, the message will be sent as a segmented message and reassembled on the peer side.

Definition at line 384 of file nrf_mesh.h.

Field Documentation

◆ dst

nrf_mesh_address_t nrf_mesh_tx_params_t::dst

Packet destination address.

Definition at line 387 of file nrf_mesh.h.

◆ src

uint16_t nrf_mesh_tx_params_t::src

Address of the element the packet originates from (must be a unicast address).

Definition at line 389 of file nrf_mesh.h.

◆ ttl

uint8_t nrf_mesh_tx_params_t::ttl

Time to live value for the packet, this is a 7 bit value.

Definition at line 391 of file nrf_mesh.h.

◆ force_segmented

bool nrf_mesh_tx_params_t::force_segmented

See Section 3.7.5.2 in the Mesh Profile Specification v1.0.

Definition at line 393 of file nrf_mesh.h.

◆ p_data

const uint8_t* nrf_mesh_tx_params_t::p_data

Points to the payload to be sent.

Definition at line 397 of file nrf_mesh.h.

◆ data_len

uint16_t nrf_mesh_tx_params_t::data_len

Length of the payload being sent.

Definition at line 399 of file nrf_mesh.h.

◆ security_material

nrf_mesh_secmat_t nrf_mesh_tx_params_t::security_material

Required for encryption.

See also
nrf_mesh_secmat_t.

Definition at line 401 of file nrf_mesh.h.

◆ tx_token

nrf_mesh_tx_token_t nrf_mesh_tx_params_t::tx_token

Token that can be used as a reference in the TX complete callback.

Definition at line 403 of file nrf_mesh.h.


The documentation for this struct was generated from the following file:

Documentation feedback | Developer Zone | Subscribe | Updated