ProxyOptions Class

  • Reference

A class containing various options to send traffic through proxy servers by enabling proxying of MQTT connection.

Initializer for proxy options. :param str proxy_type: The type of the proxy server. This can be one of three possible choices: "HTTP", "SOCKS4", or "SOCKS5" :param str proxy_addr: IP address or DNS name of proxy server :param int proxy_port: The port of the proxy server. Defaults to 1080 for socks and 8080 for http. :param str proxy_username: (optional) username for SOCKS5 proxy, or userid for SOCKS4 proxy.This parameter is ignored if an HTTP server is being used.

If it is not provided, authentication will not be used (servers may accept unauthenticated requests).

Inheritance
builtins.object
ProxyOptions

Constructor

ProxyOptions(proxy_type, proxy_addr, proxy_port, proxy_username=None, proxy_password=None)

Parameters

Name Description
proxy_password
str

(optional) This parameter is valid only for SOCKS5 servers and specifies the respective password for the username provided.

Default value: None
proxy_type
Required
proxy_addr
Required
proxy_port
Required
proxy_username
Default value: None

Attributes

proxy_address

proxy_password

proxy_port

proxy_type

proxy_type_socks

proxy_username