zbus_channel Struct Reference

Type used to represent a channel. More...

#include <zbus.h>

Data Fields
const char *const	name
	Channel name.
void *const	message
	Message reference.
const size_t	message_size
	Message size.
void *const	user_data
	User data available to extend zbus features.
bool(*const	validator )(const void *msg, size_t msg_size)
	Message validator.
struct zbus_channel_data *const	data
	Mutable channel data struct.

Detailed Description

Type used to represent a channel.

Every channel has a zbus_channel structure associated used to control the channel access and usage.

Field Documentation

data

struct zbus_channel_data* const zbus_channel::data

Mutable channel data struct.

message

void* const zbus_channel::message

Message reference.

Represents the message's reference that points to the actual shared memory region.

message_size

const size_t zbus_channel::message_size

Message size.

Represents the channel's message size.

name

const char* const zbus_channel::name

Channel name.

user_data

void* const zbus_channel::user_data

User data available to extend zbus features.

The channel must be claimed before using this field.

validator

bool(*const zbus_channel::validator) (const void *msg, size_t msg_size)

Message validator.

Stores the reference to the function to check the message validity before actually performing the publishing. No invalid messages can be published. Every message is valid when this field is empty.

---

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

• include/zephyr/zbus/zbus.h