This is an extension to allow using the Mosquitto MQTT library with PHP. See the examples/ directory for usage.

• PHP 5.3+
• libmosquitto 1.2.1 (this is the only version I have tested)
• Linux or Mac OS X. I do not have a Windows machine handy, though patches or pull requests are of course very welcome!

You may obtain this package using my PECL channel, if you prefer:

pecl channel-discover pecl.mgdm.net
pecl install Mosquitto-alpha

Alternatively, you can use the normal extension build process:

phpize
./configure --with-mosquitto=/path/to/libmosquitto
make
make install

Then add extension=mosquitto.so to your php.ini.

The --with-mosquitto argument is optional, and only required if your libmosquitto install cannot be found.

The classes in this extension are namespaced.

This is the actual Mosquitto client.

1. __construct - create a new client
2. setCredentials - set the credentials to use on connection
3. setWill - set the client will, to be delivered if disconnected uncleanly
4. clearWill - clear a previously-set will
5. setReconnectDelay - set the behaviour if disconnected uncleanly
6. connect - connect to an MQTT broker
7. disconnect - disconnect from an MQTT broker
8. onConnect - set the connect callback
9. onDisconnect - set the disconnect callback
10. onLog - set the logging callback
11. onSubscribe - set the subscribe callback
12. onMessage - set the callback fired when a message is received
13. setMaxInFlightMessages - set the number of QoS 1 and 2 messages that can be "in flight" at once
14. setMessageRetry - set the number of seconds to wait before retrying messages
15. publish - publish a message to a broker
16. subscribe - subscribe to a topic
17. unsubscribe - unsubscribe from a topic
18. loop - The main network loop
19. loopForever - run loop() in an infinite blocking loop

Creates a new Client instance.

Set the username and password to use on connecting to the broker. Must be called before connect().

Set the client "last will and testament", which will be sent on an unclean disconnection from the broker. Must be called before connect().

Remove a previously-set will. No parameters.

Control the behaviour of the client when it has unexpectedly disconnected in loopForever. The default behaviour if this method is not used is to repeatedly attempt to reconnect with a delay of 1 second until the connection succeeds.

Connect to an MQTT broker.

Disconnect from the broker. No parameters.

Set the connect callback. This is called when the broker sends a CONNACK message in response to a connection.

The callback should take parameters of the form:

Response codes are as follows:

Set the disconnect callback. This is called when the broker has received the DISCONNECT command and has disconnected the client.

The callback should take parameters of the form:

Set the logging callback.

The callback should take parameters of the form:

The level can be one of:

• Mosquitto\Client::LOG_DEBUG
• Mosquitto\Client::LOG_INFO
• Mosquitto\Client::LOG_NOTICE
• Mosquitto\Client::LOG_WARNING
• Mosquitto\Client::LOG_ERR

Set the subscribe callback. This is called when the broker responds to a subscription request.

The callback should take parameters of the form:

This function needs to return the granted QoS for each subscription, but currently cannot.

Set the unsubscribe callback. This is called when the broker responds to a unsubscribe request.

The callback should take parameters of the form:

Set the message callback. This is called when a message is received from the broker.

The callback should take parameters of the form:

Set the number of QoS 1 and 2 messages that can be “in flight” at one time. An in flight message is part way through its delivery flow. Attempts to send further messages with publish() will result in the messages being queued until the number of in flight messages reduces.

Set to 0 for no maximum.

Set the number of seconds to wait before retrying messages. This applies to publish messages with QoS>0. May be called at any time.

Publish a message on a given topic.

Subscribe to a topic.

Returns the message ID of the subscription message, so this can be matched up in the onSubscribe callback.

Unsubscribe from a topic.

Returns the message ID of the subscription message, so this can be matched up in the onUnsubscribe callback.

The main network loop for the client. You must call this frequently in order to keep communications between the client and broker working. If incoming data is present it will then be processed. Outgoing commands, from e.g. publish(), are normally sent immediately that their function is called, but this is not always possible. loop() will also attempt to send any remaining outgoing messages, which also includes commands that are part of the flow for messages with QoS>0.

Call loop() in an infinite blocking loop. Callbacks will be called as required. This will handle reconnecting if the connection is lost. Call disconnect() in a callback to return from the loop.

Represents a message received from a broker. All data is represented as properties.

This class has one static method.

Returns true if the supplied topic matches the supplied description, and otherwise false.

This is an exception that may be thrown by many of the operations in the Client object.

• Arginfo
• Logging callbacks
• TLS support
• Tests