MQTT¶
Description¶
iRules events and commands related to the MQTT protocol.
Command List¶
- MQTT::clean_session - gets or sets the clean_session flag of MQTT CONNECT messages
- MQTT::client_id - gets or sets the client identifier of MQTT CONNECT message
- MQTT::collect - collects the specified amount of MQTT message payload data
- MQTT::disable - disables MQTT parsing on a connection
- MQTT::disconnect - disconnects the MQTT connection
- MQTT::drop - drops the current MQTT message
- MQTT::dup - gets or sets the duplicate flag of MQTT PUBLISH messages
- MQTT::enable - enables MQTT parsing on a connection
- MQTT::insert - inserts an MQTT message
- MQTT::keep_alive - gets or sets the keep_alive field of MQTT CONNECT message
- MQTT::length - gets the length of an MQTT message
- MQTT::message - returns the full content of the MQTT message
- MQTT::packet_id - gets or sets the packet-id of an MQTT message
- MQTT::password - gets or sets the password field of an MQTT CONNECT message
- MQTT::payload - manipulates the payload of an MQTT PUBLISH message
- MQTT::protocol_name - gets or sets the protocol-name of an MQTT CONNECT message
- MQTT::protocol_version - gets or sets the protocol revision level of an MQTT CONNECT message
- MQTT::qos - gets or sets the qos of MQTT PUBLISH messages
- MQTT::release - releases the data collected via MQTT::collect
- MQTT::replace - replaces an MQTT message
- MQTT::respond - transmits an MQTT message to sender
- MQTT::retain - gets or sets the retain flag of MQTT PUBLISH messages
- MQTT::return_code - gets or sets the return-code field of MQTT CONNACK messages
- MQTT::return_code_list - gets the return-code-list of MQTT SUBACK message
- MQTT::session_present - gets or sets the session_present flag of MQTT CONNACK message
- MQTT::topic - manipulates topic(s) of MQTT messages
- MQTT::type - gets the type of MQTT messages
- MQTT::username - gets or sets the username field of MQTT CONNECT messages
- MQTT::will - gets or sets the will-topic, will-message, will-qos, and will-retain fields of MQTT CONNECT messages
Event List¶
- MQTT_CLIENT_DATA - triggers when an a prior MQTT::collect command finishes
- MQTT_CLIENT_EGRESS - triggered when an MQTT message is sent to client-side
- MQTT_CLIENT_INGRESS - triggers when an MQTT message is received from client-side
- MQTT_CLIENT_SHUTDOWN - triggered when MQTT client closes TCP connection
- MQTT_SERVER_DATA - triggers when server-side payload data collection invoked using MQTT::collect finishes
- MQTT_SERVER_EGRESS - triggered when an MQTT message is sent to server-side
- MQTT_SERVER_INGRESS - triggers when an MQTT message is received from server-side
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.