Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use ReadTheDocs for documentation #50

Merged
merged 12 commits into from
Sep 6, 2016
Merged

Use ReadTheDocs for documentation #50

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
6b6935f
Initial Sphinx docs implementation
mgdm Sep 5, 2016
aae11f6
Try and include PHP domain extension
mgdm Sep 5, 2016
5590664
Use RTD theme and add Github widget
mgdm Sep 5, 2016
c5bcca5
Remove docs from README
mgdm Sep 5, 2016
5ef12f2
Add Message and Exception documentation
mgdm Sep 5, 2016
191ab85
Update Exception docs
mgdm Sep 5, 2016
9c84e05
Remove obsolete TODO section
mgdm Sep 5, 2016
7c99326
Add a quick one-liner intro
mgdm Sep 5, 2016
afe1657
We're on PHP 7
mgdm Sep 5, 2016
c8e3b9b
Update CREDITS
mgdm Sep 5, 2016
77cef10
Add cross-references
mgdm Sep 6, 2016
18c5cb6
Document constants
mgdm Sep 6, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Document constants
  • Loading branch information
@mgdm
mgdm committed Sep 6, 2016
commit 18c5cb6156fe03eb17c4705063d5f1d698cd797c
40 changes: 34 additions & 6 deletions docs/client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,34 @@ Mosquitto\\Client

This is the main Mosquitto client.

.. php:const:: LOG_DEBUG

Identifies a debug-level log message

.. php:const:: LOG_INFO

Identifies an info-level log message

.. php:const:: LOG_NOTICE

Identifies a notice-level log message

.. php:const:: LOG_WARNING

Identifies a warning-level log message

.. php:const:: LOG_ERR

Identifies an error-level log message

.. php:const:: SSL_VERIFY_NONE

Used with :php:meth:`~Client::setTlsInsecure`. Do not verify the identity of the server, thus making the connection insecure.

.. php:const:: SSL_VERIFY_PEER

Used with :php:meth:`~Client::setTlsInsecure`. Verify the identity of the server.

.. php:method:: __construct([$id = null, $cleanSession = true])

Construct a new Client instance.
Expand Down Expand Up @@ -69,7 +97,7 @@ Mosquitto\\Client

Remove a previously-set will. No parameters.

.. php:method:: setReconnectDelay($reconnectDelay, $exponentialDelay, $exponentialBackoff = false)
.. php:method:: setReconnectDelay($reconnectDelay, $exponentialDelay, $exponentialBackoff)

Control the behaviour of the client when it has unexpectedly disconnected in :php:meth:`Client::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.

Expand Down Expand Up @@ -136,11 +164,11 @@ Mosquitto\\Client

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``
* :php:const:`Client::LOG_DEBUG`
* :php:const:`Client::LOG_INFO`
* :php:const:`Client::LOG_NOTICE`
* :php:const:`Client::LOG_WARNING`
* :php:const:`Client::LOG_ERR`

.. php:method:: onSubscribe($callback)

Expand Down