MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html

changeset 87
fe391e485681
parent 78
a22328182bc2
child 92
2fb5c08019fd
equal deleted inserted replaced
86:620022b14cb4 87:fe391e485681
346 <p> 346 <p>
347 Public method to get a connection options dictionary with default 347 Public method to get a connection options dictionary with default
348 values. 348 values.
349 </p> 349 </p>
350 <dl> 350 <dl>
351 <dt>Returns:</dt> 351 <dt>Return:</dt>
352 <dd> 352 <dd>
353 dictionary containing the default connection options. It has 353 dictionary containing the default connection options. It has
354 the keys "ClientId", "Keepalive", "CleanSession", "Username", 354 the keys "ClientId", "Keepalive", "CleanSession", "Username",
355 "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain", 355 "Password", "WillTopic", "WillMessage", "WillQos", "WillRetain",
356 "TlsEnable", "TlsCaCert", "TlsClientCert", "TlsClientKey", 356 "TlsEnable", "TlsCaCert", "TlsClientCert", "TlsClientKey",
396 flag indicating to set as the "last known good"/retained 396 flag indicating to set as the "last known good"/retained
397 message for the topic 397 message for the topic
398 </dd> 398 </dd>
399 </dl> 399 </dl>
400 <dl> 400 <dl>
401 <dt>Returns:</dt> 401 <dt>Return:</dt>
402 <dd> 402 <dd>
403 message info object 403 message info object
404 </dd> 404 </dd>
405 </dl> 405 </dl>
406 <dl> 406 <dl>
530 <dd> 530 <dd>
531 PEM encoded private key file 531 PEM encoded private key file
532 </dd> 532 </dd>
533 </dl> 533 </dl>
534 <dl> 534 <dl>
535 <dt>Returns:</dt> 535 <dt>Return:</dt>
536 <dd> 536 <dd>
537 tuple containing a success flag and the error string of the 537 tuple containing a success flag and the error string of the
538 paho-mqtt library 538 paho-mqtt library
539 </dd> 539 </dd>
540 </dl> 540 </dl>
608 <dd> 608 <dd>
609 quality of service 609 quality of service
610 </dd> 610 </dd>
611 </dl> 611 </dl>
612 <dl> 612 <dl>
613 <dt>Returns:</dt> 613 <dt>Return:</dt>
614 <dd> 614 <dd>
615 tuple containing the result code and the message ID 615 tuple containing the result code and the message ID
616 </dd> 616 </dd>
617 </dl> 617 </dl>
618 <dl> 618 <dl>
634 <dd> 634 <dd>
635 topic or list of topics to unsubscribe 635 topic or list of topics to unsubscribe
636 </dd> 636 </dd>
637 </dl> 637 </dl>
638 <dl> 638 <dl>
639 <dt>Returns:</dt> 639 <dt>Return:</dt>
640 <dd> 640 <dd>
641 tuple containing the result code and the message ID 641 tuple containing the result code and the message ID
642 </dd> 642 </dd>
643 </dl> 643 </dl>
644 <dl> 644 <dl>
663 <dd> 663 <dd>
664 result code of the connection request 664 result code of the connection request
665 </dd> 665 </dd>
666 </dl> 666 </dl>
667 <dl> 667 <dl>
668 <dt>Returns:</dt> 668 <dt>Return:</dt>
669 <dd> 669 <dd>
670 textual representation for the result code 670 textual representation for the result code
671 </dd> 671 </dd>
672 </dl> 672 </dl>
673 <dl> 673 <dl>
693 <dd> 693 <dd>
694 result code of a MQTT request 694 result code of a MQTT request
695 </dd> 695 </dd>
696 </dl> 696 </dl>
697 <dl> 697 <dl>
698 <dt>Returns:</dt> 698 <dt>Return:</dt>
699 <dd> 699 <dd>
700 textual representation of the result code 700 textual representation of the result code
701 </dd> 701 </dd>
702 </dl> 702 </dl>
703 <dl> 703 <dl>
727 flag indicating a MQTT log level is given (if 727 flag indicating a MQTT log level is given (if
728 False it is the MqttClient variant, i.e. Debug being lowest) 728 False it is the MqttClient variant, i.e. Debug being lowest)
729 </dd> 729 </dd>
730 </dl> 730 </dl>
731 <dl> 731 <dl>
732 <dt>Returns:</dt> 732 <dt>Return:</dt>
733 <dd> 733 <dd>
734 textual representation of the log level 734 textual representation of the log level
735 </dd> 735 </dd>
736 </dl> 736 </dl>
737 <dl> 737 <dl>

eric ide

mercurial