umqtt.simple/README: Describe return value of connect().

pull/86/head
Paul Sokolovsky 2016-07-30 14:47:03 +03:00
rodzic 20cd8e4651
commit 08f7d09353
1 zmienionych plików z 3 dodań i 1 usunięć

Wyświetl plik

@ -46,7 +46,9 @@ API reference
Taking into account API traits described above, umqtt pretty closely
follows MQTT control operations, and maps them to class methods:
* ``connect()`` - Connect to a server.
* ``connect(...)`` - Connect to a server. Returns True if this connection
uses persisten session stored on a server (this will be always False if
clean_session=True argument is used (default)).
* ``disconnect()`` - Disconnect from a server, release resources.
* ``ping()`` - Ping server (response is processed automatically by wait_msg()).
* ``publish()`` - Publish a message.