MQTT::collect

Description¶

This command collects the specified amount of MQTT message payload
data before triggering a MQTT_CLIENT_DATA or MQTT_SERVER_DATA event.
When collecting data in a clientside event, the MQTT_CLIENT_DATA event
will be triggered. When collecting data in a serverside event, the
MQTT_SERVER_DATA event will be triggered.
This command is valid only for the PUBLISH MQTT message type and
allows you to perform various operations on MQTT PUBLISH messages like
modify its contents.

NOTE: Please make sure that MQTT PUBLISH message expects to receive a payload by using MQTT::payload length. This is to make sure that the payload length is not zero before calling this command.

Syntax¶

MQTT::collect [bytes]

MQTT::collect¶

Collect the entire payload of the MQTT message. To stop collecting use MQTT::release command.

MQTT::collect <bytes>¶

Collect bytes of payload of the MQTT message. If paylaod is smaller than collect entire payload. The collected data can be accessed via the MQTT::payload command. To stop collecting use MQTT::release command.

Examples¶

Related Information¶

Valid Events:
MQTT_CLIENT_INGRESS, MQTT_SERVER_INGRESS, MQTT_CLIENT_DATA,
MQTT_SERVER_DATA

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code:

Introduced: BIGIP-13.0.0

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.