ST_PublishMessage

Overview

Type:

Structure

Available as of:

V1.0.0.0

Inherits from:

-

Description

The structure ST_PublishMessage specifies the Publish message.

Structure Elements

Name

Data type

Description

pbyTopic

POINTER TO BYTE

Pointer to the variable containing the name of the topic to which the data belongs.

uiLengthOfTopic

UINT

Length of the topic name in bytes.

NOTE: The length must not be greater than the size of the variable pbyTopic points to.

pbyData

POINTER TO BYTE

Pointer to the variable containing the data to be included in the application message published throughout the MQTT server to clients with appropriate subscriptions.

uiLengthOfData

UINT

Length of the data to be included in the application message in bytes.

NOTE: The length must not exceed the size of the variable pbyTopic points to.

xRetain

BOOL

Specifies if the application message must be retained on the MQTT server.

etQualityOfService

ET_QualityOfService

Specifies the Quality of Service (QoS) with which the application message is sent.

Used By

  • FB_MqttPublish