connect Method

Connects to the remote host.

Syntax

def connect(host: str, port: int) -> None: ...

Remarks

This method connects to the remote host. Calling this method is equivalent to setting the remote_host property to Host, setting remote_port to Port, and then setting the connected property to True.

By default the class will connect in plaintext. To enable SSL set ssl_enabled to True.

In addition, WebSocket connections are supported. To connect using WebSockets specify a hostname beginning with ws:// (plaintext) or wss:// (SSL). For instance, ws://test.mosquitto.org.

When connecting to an MQTT server, the class sends the following information:

The values of the client_id, clean_session, and keep_alive_interval properties.
The value of the user property (if non-empty).
The value of the password property (if non-empty).
The values of the will_topic and will_message properties and the WillQOS and WillRetain configuration settings.
MQTT 5 specific values from ClientTopicAliasMax, SessionExpInterval, ConnectProperties and WillProperties.

If clean_session is True, check the SessionPresent configuration setting once connected to determine whether the server actually had any session state saved.

Refer to clean_session, save_session, and restore_session for more information about MQTT sessions and session state persistence; refer to will_topic, will_message, WillQOS, and WillRetain for more information about MQTT Wills.

Basic Connection Example

mqtt1.ClientId = "testClient";
mqtt1.CleanSession = true;
mqtt1.KeepAliveInterval = 30;
mqtt1.WillTopic = "wills/" + mqtt1.ClientId;
mqtt1.WillMessage = mqtt1.ClientId + " was disconnected ungracefully!";
mqtt1.Connect("mqtt.test-server.com", 1883);

IPWorks MQ 2020 Python Edition Website Download Support Questions / Feedback?
IPWorks MQ 2020 Python Edition Introduction Licensing Instructions AmazonSQS Class Introduction Properties access_key attributes_count attributes_name attributes_value firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user local_host max_messages messages_count messages_body messages_id messages_md5 messages_receipt_handle other_headers proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user queue_prefix queues_count queues_id queues_url referer secret_key ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded status_line timeout use_ssl visibility_timeout Methods add_permission change_message_visibility config create_message create_queue delete_message delete_queue do_events get_queue_attributes get_x_value interrupt list_messages list_queues remove_permission reset reset_headers send_custom_request set_queue_attribute Events on_connected on_disconnected on_end_transfer on_error on_header on_message on_queue on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes AMQP Class Introduction Properties auth_scheme connected container_id fetch_timeout firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle_timeout incoming_message_count incoming_message_absolute_expiry_time incoming_message_content_encoding incoming_message_content_type incoming_message_correlation_id incoming_message_creation_time incoming_message_delivery_count incoming_message_durable incoming_message_first_acquirer incoming_message_group_id incoming_message_group_sequence incoming_message_link_name incoming_message_id incoming_message_priority incoming_message_reply_to incoming_message_reply_to_group_id incoming_message_settled incoming_message_subject incoming_message_to incoming_message_ttl incoming_message_user_id incoming_message_value incoming_message_value_type link_count link_available link_channel_name link_credit link_delivery_count link_name link_ready_to_send link_receive_mode link_role local_host local_port message_absolute_expiry_time message_content_encoding message_content_type message_correlation_id message_creation_time message_delivery_count message_durable message_first_acquirer message_group_id message_group_sequence message_link_name message_id message_priority message_reply_to message_reply_to_group_id message_settled message_subject message_to message_ttl message_user_id message_value message_value_type outgoing_message_count outgoing_message_absolute_expiry_time outgoing_message_content_encoding outgoing_message_content_type outgoing_message_correlation_id outgoing_message_creation_time outgoing_message_delivery_count outgoing_message_durable outgoing_message_first_acquirer outgoing_message_group_id outgoing_message_group_sequence outgoing_message_link_name outgoing_message_id outgoing_message_priority outgoing_message_reply_to outgoing_message_reply_to_group_id outgoing_message_settled outgoing_message_subject outgoing_message_to outgoing_message_ttl outgoing_message_user_id outgoing_message_value outgoing_message_value_type password ready_to_send received_message_absolute_expiry_time received_message_content_encoding received_message_content_type received_message_correlation_id received_message_creation_time received_message_delivery_count received_message_durable received_message_first_acquirer received_message_group_id received_message_group_sequence received_message_link_name received_message_id received_message_priority received_message_reply_to received_message_reply_to_group_id received_message_settled received_message_subject received_message_to received_message_ttl received_message_user_id received_message_value received_message_value_type receive_mode remote_host remote_port session_count session_incoming_window session_name session_outgoing_window ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded timeout user Methods close_link close_session config connect create_receiver_link create_sender_link create_session disconnect do_events fetch_message interrupt reset reset_message send_message Events on_connected on_connection_status on_disconnected on_error on_link_ready_to_send on_log on_message_in on_message_out on_message_outcome on_ssl_server_authentication on_ssl_status Configuration Error Codes AMQPClassic Class Introduction Properties argument_count argument_name argument_value argument_value_type auth_scheme channel_count channel_accept channel_mode channel_name channel_ready_to_send client_property_count client_property_name client_property_value client_property_value_type connected firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user heartbeat incoming_message_count incoming_message_app_id incoming_message_body incoming_message_channel_name incoming_message_content_encoding incoming_message_content_type incoming_message_correlation_id incoming_message_delivery_mode incoming_message_expiration incoming_message_headers incoming_message_id incoming_message_priority incoming_message_reply_to incoming_message_timestamp incoming_message_type incoming_message_user_id local_host local_port message_app_id message_body message_channel_name message_content_encoding message_content_type message_correlation_id message_delivery_mode message_expiration message_headers message_id message_priority message_reply_to message_timestamp message_type message_user_id outgoing_message_count outgoing_message_app_id outgoing_message_body outgoing_message_channel_name outgoing_message_content_encoding outgoing_message_content_type outgoing_message_correlation_id outgoing_message_delivery_mode outgoing_message_expiration outgoing_message_headers outgoing_message_id outgoing_message_priority outgoing_message_reply_to outgoing_message_timestamp outgoing_message_type outgoing_message_user_id password queue_message_count received_message_app_id received_message_body received_message_channel_name received_message_content_encoding received_message_content_type received_message_correlation_id received_message_delivery_mode received_message_expiration received_message_headers received_message_id received_message_priority received_message_reply_to received_message_timestamp received_message_type received_message_user_id remote_host remote_port server_property_count server_property_name server_property_value server_property_value_type ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded timeout user virtual_host Methods bind_queue cancel_consume close_channel commit_transaction config connect consume create_channel declare_exchange declare_queue delete_exchange delete_queue disconnect do_events enable_publish_confirms enable_transaction_mode fetch_message interrupt publish_message purge_queue recover reset reset_message rollback_transaction set_channel_accept set_qos unbind_queue Events on_channel_ready_to_send on_connected on_connection_status on_disconnected on_error on_log on_message_in on_message_out on_message_returned on_ssl_server_authentication on_ssl_status Configuration Error Codes AzureRelayProxy Class Introduction Properties access_key access_key_name connection_backlog azure_relay_proxy_connection_count azure_relay_proxy_connection_connected azure_relay_proxy_connection_connection_id azure_relay_proxy_connection_idle_timeout azure_relay_proxy_connection_local_address azure_relay_proxy_connection_remote_host azure_relay_proxy_connection_remote_port azure_relay_proxy_connection_timeout azure_relay_proxy_connection_user_data default_idle_timeout default_timeout hybrid_connection keep_alive linger listening local_host local_port namespace_address ssl_authenticate_clients ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_start_mode Methods config disconnect do_events reset shutdown Events on_connected on_connection_request on_disconnected on_error on_log on_ssl_client_authentication on_ssl_connection_request on_ssl_status Configuration Error Codes AzureRelayReceiver Class Introduction Properties access_key access_key_name connected azure_relay_connection_count azure_relay_connection_accept_data azure_relay_connection_address azure_relay_connection_bytes_sent azure_relay_connection_connected azure_relay_connection_connect_headers azure_relay_connection_connection_id azure_relay_connection_data_format azure_relay_connection_data_to_send azure_relay_connection_extensions azure_relay_connection_host azure_relay_connection_id azure_relay_connection_ready_to_send azure_relay_connection_remote_address azure_relay_connection_remote_port azure_relay_connection_sub_protocols azure_relay_connection_timeout default_timeout firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user forwarding_host forwarding_port hybrid_connection listening local_host namespace_address proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded Methods config disconnect do_events interrupt send send_file send_http_response send_text shutdown Events on_connected on_connection_connected on_connection_data_in on_connection_disconnected on_connection_error on_connection_ready_to_send on_connection_request on_connection_status on_disconnected on_error on_header on_http_request on_log on_redirect on_ssl_server_authentication on_ssl_status Configuration Error Codes AzureRelaySender Class Introduction Properties accept_data access_key access_key_name bytes_sent connected data_format data_to_send firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user hybrid_connection local_host local_port namespace_address other_headers parsed_header_count parsed_header_field parsed_header_value proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user ready_to_send ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded sub_protocols timeout transferred_headers Methods config connect disconnect do_events interrupt reset send send_file send_text Events on_connected on_connection_status on_data_in on_disconnected on_error on_header on_log on_ready_to_send on_redirect on_ssl_server_authentication on_ssl_status Configuration Error Codes CertMgr Class Introduction Properties cert_effective_date cert_encoded cert_expiration_date cert_extended_key_usage cert_fingerprint cert_issuer cert_key_password cert_private_key cert_private_key_available cert_private_key_container cert_public_key cert_public_key_algorithm cert_public_key_length cert_serial_number cert_signature_algorithm cert_subject cert_subject_alt_names cert_thumbprint_md5 cert_thumbprint_sha1 cert_thumbprint_sha256 cert_usage cert_usage_flags cert_version cert_extension_count cert_extension_critical cert_extension_oid cert_extension_value cert_store cert_store_password cert_store_type exported_cert export_format export_private_key Methods config create_certificate create_key delete_certificate delete_key export_certificate generate_csr import_certificate import_signed_csr issue_certificate list_certificate_stores list_keys list_machine_stores list_store_certificates read_certificate read_csr reset save_certificate show_certificate_chain sign_csr Events on_cert_chain on_cert_list on_error on_key_list on_log on_store_list Configuration Error Codes JSON Class Introduction Properties build_dom input_data input_file output_data output_file overwrite validate x_child_count x_child_name x_child_x_text x_element x_element_type x_error_path x_parent x_path x_sub_tree x_text Methods config end_array end_object flush has_x_path insert_property insert_value load_schema parse put_name put_property put_raw put_value remove reset save set_name set_value start_array start_object try_x_path Events on_characters on_end_document on_end_element on_error on_ignorable_whitespace on_json on_start_document on_start_element Configuration Error Codes MQTT Class Introduction Properties clean_session client_id connected firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user incoming_message_count incoming_message_content_type incoming_message_correlation_data incoming_message_duplicate incoming_message_message incoming_message_message_exp_interval incoming_message_packet_id incoming_message_payload_format_indicator incoming_message_qos incoming_message_response_topic incoming_message_retained incoming_message_state incoming_message_subscription_identifiers incoming_message_topic incoming_message_topic_alias keep_alive_interval local_host local_port outgoing_message_count outgoing_message_content_type outgoing_message_correlation_data outgoing_message_duplicate outgoing_message_message outgoing_message_message_exp_interval outgoing_message_packet_id outgoing_message_payload_format_indicator outgoing_message_qos outgoing_message_response_topic outgoing_message_retained outgoing_message_state outgoing_message_subscription_identifiers outgoing_message_topic outgoing_message_topic_alias password ready_to_send remote_host remote_port ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded timeout user version will_message will_topic Methods config connect disconnect do_events interrupt publish_data publish_message reset restore_session save_session subscribe unsubscribe Events on_connected on_connection_status on_disconnected on_error on_log on_message_ack on_message_in on_message_out on_ready_to_send on_ssl_server_authentication on_ssl_status on_subscribed on_unsubscribed Configuration Error Codes STOMP Class Introduction Properties connected content_type firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user header_count header_key header_value incoming_heartbeat local_host local_port outgoing_heartbeat parsed_header_count parsed_header_key parsed_header_value password ready_to_send remote_host remote_port request_receipts ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded subscription_count subscription_destination subscription_id timeout transaction_id user Methods abort_transaction add_header begin_transaction commit_transaction config connect disconnect do_events interrupt reset reset_headers send_data send_message subscribe unsubscribe Events on_connected on_connection_status on_disconnected on_error on_log on_message_in on_message_out on_ready_to_send on_receipt_in on_receipt_out on_ssl_server_authentication on_ssl_status on_subscribed on_unsubscribed Configuration Error Codes XMPP Class Introduction Properties auth_domain auth_methods buddy_count buddy_group buddy_id buddy_nick_name buddy_real_name buddy_subscription connected firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user im_port im_server local_directory local_file local_host message_html message_other_data message_subject message_text message_thread message_type password presence resource server_domain ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode status timeout user user_domain user_info_count user_info_field user_info_value Methods add cancel change_password change_presence config connect disconnect do_events interrupt probe_presence query_register register remove reset retrieve_roster send_command send_file send_message set_user_info_field subscribe_to unregister unsubscribe_to Events on_buddy_update on_connected on_connection_status on_disconnected on_end_transfer on_error on_iq on_message_in on_pi_trail on_presence on_ready_to_send on_ssl_server_authentication on_ssl_status on_start_transfer on_subscription_request on_sync on_transfer Configuration Error Codes Software License	connect Method Connects to the remote host. Syntax def connect(host: str, port: int) -> None: ... Remarks This method connects to the remote host. Calling this method is equivalent to setting the remote_host property to Host, setting remote_port to Port, and then setting the connected property to True. By default the class will connect in plaintext. To enable SSL set ssl_enabled to True. In addition, WebSocket connections are supported. To connect using WebSockets specify a hostname beginning with `ws://` (plaintext) or `wss://` (SSL). For instance, `ws://test.mosquitto.org`. When connecting to an MQTT server, the class sends the following information: The values of the client_id, clean_session, and keep_alive_interval properties. The value of the user property (if non-empty). The value of the password property (if non-empty). The values of the will_topic and will_message properties and the WillQOS and WillRetain configuration settings. MQTT 5 specific values from ClientTopicAliasMax, SessionExpInterval, ConnectProperties and WillProperties. If clean_session is True, check the SessionPresent configuration setting once connected to determine whether the server actually had any session state saved. Refer to clean_session, save_session, and restore_session for more information about MQTT sessions and session state persistence; refer to will_topic, will_message, WillQOS, and WillRetain for more information about MQTT Wills. Basic Connection Example view source `mqtt1.ClientId =` `"testClient";` `mqtt1.CleanSession =` `true;` `mqtt1.KeepAliveInterval = 30;` `mqtt1.WillTopic =` `"wills/"` `+ mqtt1.ClientId;` `mqtt1.WillMessage = mqtt1.ClientId +` `" was disconnected ungracefully!";` `mqtt1.Connect("mqtt.test-server.com", 1883);`
Copyright (c) 2022 /n software inc. - All rights reserved. IPWorks MQ 2020 Python Edition - Version 20.0 [Build 8155]

IPWorks MQ 2020 Python Edition

connect Method

Syntax

Remarks

Questions / Feedback?