Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
msg.h File Reference

Message APIs. More...

#include <zephyr.h>
#include <net/buf.h>

Go to the source code of this file.

Data Structures

struct  bt_mesh_msg_ctx
 
struct  bt_mesh_msg_ack_ctx
 

Macros

#define BT_MESH_MIC_SHORT   4
 
#define BT_MESH_MIC_LONG   8
 
#define BT_MESH_MODEL_OP_LEN(_op)   ((_op) <= 0xff ? 1 : (_op) <= 0xffff ? 2 : 3)
 Helper to determine the length of an opcode. More...
 
#define BT_MESH_MODEL_BUF_LEN(_op, _payload_len)    (BT_MESH_MODEL_OP_LEN(_op) + (_payload_len) + BT_MESH_MIC_SHORT)
 Helper for model message buffer length. More...
 
#define BT_MESH_MODEL_BUF_LEN_LONG_MIC(_op, _payload_len)    (BT_MESH_MODEL_OP_LEN(_op) + (_payload_len) + BT_MESH_MIC_LONG)
 Helper for model message buffer length. More...
 
#define BT_MESH_MODEL_BUF_DEFINE(_buf, _op, _payload_len)    NET_BUF_SIMPLE_DEFINE(_buf, BT_MESH_MODEL_BUF_LEN(_op, (_payload_len)))
 Define a Mesh model message buffer using NET_BUF_SIMPLE_DEFINE. More...
 

Functions

void bt_mesh_model_msg_init (struct net_buf_simple *msg, uint32_t opcode)
 Initialize a model message. More...
 
static void bt_mesh_msg_ack_ctx_init (struct bt_mesh_msg_ack_ctx *ack)
 Initialize an acknowledged message context. More...
 
static void bt_mesh_msg_ack_ctx_reset (struct bt_mesh_msg_ack_ctx *ack)
 Reset the synchronization semaphore in an acknowledged message context. More...
 
void bt_mesh_msg_ack_ctx_clear (struct bt_mesh_msg_ack_ctx *ack)
 Clear parameters of an acknowledged message context. More...
 
int bt_mesh_msg_ack_ctx_prepare (struct bt_mesh_msg_ack_ctx *ack, uint32_t op, uint16_t dst, void *user_data)
 Prepare an acknowledged message context for the incoming message to wait. More...
 
static bool bt_mesh_msg_ack_ctx_busy (struct bt_mesh_msg_ack_ctx *ack)
 Check if the acknowledged message context is initialized with an opcode. More...
 
int bt_mesh_msg_ack_ctx_wait (struct bt_mesh_msg_ack_ctx *ack, k_timeout_t timeout)
 Wait for a message acknowledge. More...
 
static void bt_mesh_msg_ack_ctx_rx (struct bt_mesh_msg_ack_ctx *ack)
 Mark a message as acknowledged. More...
 
bool bt_mesh_msg_ack_ctx_match (const struct bt_mesh_msg_ack_ctx *ack, uint32_t op, uint16_t addr, void **user_data)
 Check if an opcode and address of a message matches the expected one. More...
 

Detailed Description

Message APIs.