shell_mqtt Struct Reference

MQTT-based shell transport. More...

#include <shell_mqtt.h>

Data Structures
struct	buffer

Public Types
enum	sh_mqtt_transport_state { SHELL_MQTT_TRANSPORT_DISCONNECTED , SHELL_MQTT_TRANSPORT_CONNECTED }
	MQTT connection states. More...
enum	sh_mqtt_subscribe_state { SHELL_MQTT_NOT_SUBSCRIBED , SHELL_MQTT_SUBSCRIBED }
	MQTT subscription states. More...
enum	sh_mqtt_network_state { SHELL_MQTT_NETWORK_DISCONNECTED , SHELL_MQTT_NETWORK_CONNECTED }
	Network states. More...

Data Fields
char	device_id [((3 *2)+1)]
char	sub_topic [((3 *2)+1)+3]
char	pub_topic [((3 *2)+1)+3]
shell_transport_handler_t	shell_handler
	Handler function registered by shell.
struct ring_buf	rx_rb
uint8_t	rx_rb_buf [CONFIG_SHELL_MQTT_RX_BUF_SIZE]
uint8_t *	rx_rb_ptr
struct shell_mqtt_tx_buf	tx_buf
void *	shell_context
	Context registered by shell.
struct mqtt_client	mqtt_cli
	The mqtt client struct.
struct shell_mqtt::buffer	buf
struct k_mutex	lock
struct sockaddr_storage	broker
	MQTT Broker details.
struct zsock_addrinfo *	haddr
struct zsock_pollfd	fds [1]
int	nfds
struct mqtt_publish_param	pub_data
struct net_mgmt_event_callback	mgmt_cb
struct k_work_q	workq
	work
struct k_work	net_disconnected_work
struct k_work_delayable	connect_dwork
struct k_work_delayable	subscribe_dwork
struct k_work_delayable	process_dwork
struct k_work_delayable	publish_dwork
enum shell_mqtt::sh_mqtt_transport_state	transport_state
enum shell_mqtt::sh_mqtt_subscribe_state	subscribe_state
enum shell_mqtt::sh_mqtt_network_state	network_state

Detailed Description

MQTT-based shell transport.

Member Enumeration Documentation

sh_mqtt_network_state

enum shell_mqtt::sh_mqtt_network_state

Network states.

Enumerator
SHELL_MQTT_NETWORK_DISCONNECTED
SHELL_MQTT_NETWORK_CONNECTED

sh_mqtt_subscribe_state

enum shell_mqtt::sh_mqtt_subscribe_state

MQTT subscription states.

Enumerator
SHELL_MQTT_NOT_SUBSCRIBED
SHELL_MQTT_SUBSCRIBED

sh_mqtt_transport_state

enum shell_mqtt::sh_mqtt_transport_state

MQTT connection states.

Enumerator
SHELL_MQTT_TRANSPORT_DISCONNECTED
SHELL_MQTT_TRANSPORT_CONNECTED

Field Documentation

broker

struct sockaddr_storage shell_mqtt::broker

MQTT Broker details.

buf

struct shell_mqtt::buffer shell_mqtt::buf

connect_dwork

struct k_work_delayable shell_mqtt::connect_dwork

device_id

char shell_mqtt::device_id[((3 *2)+1)]

fds

struct zsock_pollfd shell_mqtt::fds[1]

haddr

struct zsock_addrinfo* shell_mqtt::haddr

lock

struct k_mutex shell_mqtt::lock

mgmt_cb

struct net_mgmt_event_callback shell_mqtt::mgmt_cb

mqtt_cli

struct mqtt_client shell_mqtt::mqtt_cli

The mqtt client struct.

net_disconnected_work

struct k_work shell_mqtt::net_disconnected_work

network_state

enum shell_mqtt::sh_mqtt_network_state shell_mqtt::network_state

nfds

int shell_mqtt::nfds

process_dwork

struct k_work_delayable shell_mqtt::process_dwork

pub_data

struct mqtt_publish_param shell_mqtt::pub_data

pub_topic

char shell_mqtt::pub_topic[((3 *2)+1)+3]

publish_dwork

struct k_work_delayable shell_mqtt::publish_dwork

rx_rb

struct ring_buf shell_mqtt::rx_rb

rx_rb_buf

uint8_t shell_mqtt::rx_rb_buf[CONFIG_SHELL_MQTT_RX_BUF_SIZE]

rx_rb_ptr

uint8_t* shell_mqtt::rx_rb_ptr

shell_context

void* shell_mqtt::shell_context

Context registered by shell.

shell_handler

shell_transport_handler_t shell_mqtt::shell_handler

Handler function registered by shell.

sub_topic

char shell_mqtt::sub_topic[((3 *2)+1)+3]

subscribe_dwork

struct k_work_delayable shell_mqtt::subscribe_dwork

subscribe_state

enum shell_mqtt::sh_mqtt_subscribe_state shell_mqtt::subscribe_state

transport_state

enum shell_mqtt::sh_mqtt_transport_state shell_mqtt::transport_state

tx_buf

struct shell_mqtt_tx_buf shell_mqtt::tx_buf

workq

struct k_work_q shell_mqtt::workq

work

---

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

• include/zephyr/shell/shell_mqtt.h