kopia lustrzana https://github.com/Yakifo/amqtt
Fix toc and add missing documents
rodzic
56e0b92fcf
commit
d71b9c1483
|
@ -44,14 +44,11 @@ Once you have a environment setup and ready, HBMQTT can be installed with the fo
|
||||||
User guide
|
User guide
|
||||||
----------
|
----------
|
||||||
|
|
||||||
If you need HBMQTT for running a MQTT client or deploying a MQTT broker, the :doc:`quickstart` describes how to use
|
If you need HBMQTT for running a MQTT client or deploying a MQTT broker, the :doc:`quickstart` describes how to use console scripts provided by HBMQTT.
|
||||||
console scripts provided by HBMQTT.
|
|
||||||
|
|
||||||
If you want to develop an application which needs to connect to a MQTT broker, the :doc:`client` reference documentation
|
If you want to develop an application which needs to connect to a MQTT broker, the :doc:`references/mqttclient` documentation explains how to use HBMQTT API for connecting, publishing and subscribing with a MQTT broker.
|
||||||
explains how to use HBMQTT API for connecting, publishing and subscribing with a MQTT broker.
|
|
||||||
|
|
||||||
If you want to run you own MQTT broker, th :doc:`broker` reference documentation explains how to embed a MQTT broker
|
If you want to run you own MQTT broker, th :doc:`references/broker` reference documentation explains how to embed a MQTT broker inside a Python application.
|
||||||
inside a Python application.
|
|
||||||
|
|
||||||
News and updates are listed in the :doc:`changelog`.
|
News and updates are listed in the :doc:`changelog`.
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
Broker API reference
|
||||||
|
====================
|
||||||
|
|
||||||
|
TBD
|
|
@ -13,6 +13,9 @@ Console scripts
|
||||||
Programming API
|
Programming API
|
||||||
---------------
|
---------------
|
||||||
|
|
||||||
|
* :doc:`mqttclient` : MQTT client API reference
|
||||||
|
* :doc:`broker` : MQTT broker API reference
|
||||||
|
|
||||||
TBD
|
TBD
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
|
@ -21,5 +24,5 @@ TBD
|
||||||
hbmqtt_pub
|
hbmqtt_pub
|
||||||
hbmqtt_sub
|
hbmqtt_sub
|
||||||
hbmqtt
|
hbmqtt
|
||||||
|
mqttclient
|
||||||
|
broker
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
MQTTClient API reference
|
||||||
|
========================
|
||||||
|
|
||||||
|
TBD
|
|
@ -30,7 +30,6 @@ from .plugins.manager import PluginManager, BaseContext
|
||||||
|
|
||||||
_defaults = {
|
_defaults = {
|
||||||
'timeout-disconnect-delay': 2,
|
'timeout-disconnect-delay': 2,
|
||||||
'publish-retry-delay': 5,
|
|
||||||
'auth': {
|
'auth': {
|
||||||
'allow-anonymous': True,
|
'allow-anonymous': True,
|
||||||
'password-file': None
|
'password-file': None
|
||||||
|
@ -166,7 +165,6 @@ class Broker:
|
||||||
bind: 0.0.0.0:8080
|
bind: 0.0.0.0:8080
|
||||||
type: ws
|
type: ws
|
||||||
timeout-disconnect-delay: 2
|
timeout-disconnect-delay: 2
|
||||||
publish-retry-delay: 5
|
|
||||||
auth:
|
auth:
|
||||||
plugins: ['auth.anonymous'] #List of plugins to activate for authentication among all registered plugins
|
plugins: ['auth.anonymous'] #List of plugins to activate for authentication among all registered plugins
|
||||||
allow-anonymous: true / false
|
allow-anonymous: true / false
|
||||||
|
@ -380,7 +378,6 @@ class Broker:
|
||||||
if client_session.keep_alive > 0:
|
if client_session.keep_alive > 0:
|
||||||
client_session.keep_alive += self.config['timeout-disconnect-delay']
|
client_session.keep_alive += self.config['timeout-disconnect-delay']
|
||||||
self.logger.debug("Keep-alive timeout=%d" % client_session.keep_alive)
|
self.logger.debug("Keep-alive timeout=%d" % client_session.keep_alive)
|
||||||
client_session.publish_retry_delay = self.config['publish-retry-delay']
|
|
||||||
|
|
||||||
handler.attach(client_session, reader, writer)
|
handler.attach(client_session, reader, writer)
|
||||||
self._sessions[client_session.client_id] = (client_session, handler)
|
self._sessions[client_session.client_id] = (client_session, handler)
|
||||||
|
|
Ładowanie…
Reference in New Issue