94.4. 组件选项


Paho 组件支持 31 个选项,如下所列。

Name描述默认值类型

automaticReconnect (common)

设置在连接丢失时客户端是否自动尝试重新连接到服务器。如果设置为 false,则在连接丢失时客户端不会尝试自动重新连接到服务器。如果设置为 true,如果连接丢失,客户端将尝试重新连接到服务器。它初始会在尝试重新连接前等待 1 秒,对于每个失败的尝试,其延长会加倍,指定 2 分钟为止,此时,延迟会一直为 2 分钟。

true

布尔值

brokerUrl (common)

MQTT 代理的 URL。

tcp://localhost:1883

字符串

cleanSession (common)

设置客户端和服务器在重新启动和重新连接后是否应记住状态。如果设置为 false,则客户端和服务器在重启客户端、服务器和连接后将维持状态。由于状态被维护:消息交付将可靠满足指定的 QOS,即使客户端、服务器或连接被重启也是如此。服务器会将订阅视为持久。如果设置为 true,则客户端和服务器在重启客户端、服务器或连接时不会维护状态。这意味着,如果客户端、服务器或连接被重启,则消息发送到指定的 QOS 无法被维护。服务器会将订阅视为非持久性。

true

布尔值

clientId (common)

MQTT 客户端标识符。标识符必须是唯一的。

 

字符串

configuration (common)

使用共享 Paho 配置。

 

PahoConfiguration

connectionTimeout (common)

设置连接超时值。这个值(以秒为单位)定义客户端等待 MQTT 服务器的网络连接的最大时间间隔(以秒为单位)。默认超时为 30 秒。值 0 禁用超时处理意味着客户端将等待到网络连接成功或失败。

30

int

file PersistenceDirectory (common)

文件持久性使用的基础目录。默认情况下,将使用 user 目录。

 

字符串

keepAliveInterval (common)

设置 keep alive 间隔。这个值(以秒为单位)定义发送或接收的消息之间的最大时间间隔。它使客户端能够检测服务器是否不再可用,而无需等待 TCP/IP 超时。客户端将确保每个保持活跃期间内至少有一个消息在网络间传输。如果在一段时间内没有与数据相关的消息,客户端会发送一个非常小的 ping 消息,后者将确认服务器。值 0 可禁用客户端中的 keepalive 处理。默认值为 60 秒。

60

int

maxInflight (common)

设置 max inflight。请在高流量环境中增加这个值。默认值为 10。

10

int

maxReconnectDelay (common)

获取重新连接之间等待的最长时间(以 millis)。

128000

int

mqttVersion (common)

设置 MQTT 版本。默认操作是与版本 3.1.1 连接,如果失败,则回退到 3.1。可以使用 MQTT_VERSION_3_1_1 或 MQTT_VERSION_3_1 选项,专门选择版本 3.1.1 或 3.1,且无回退。

 

int

Persistence (common)

要使用的客户端持久性 - 内存或文件。

Enum 值:

  • FILE
  • MEMORY

MEMORY

PahoPersistence

QoS (common)

客户端服务质量级别(0-2)。

2

int

reserved (common)

Retain 选项。

false

布尔值

serverURIs (common)

设置客户端可以连接到的一个或多个 serverURI 的列表。可以使用逗号分隔多个服务器。每个 serverURI 指定客户端可以连接的服务器的地址。对于 TCP 连接,支持两种类型的连接,ssl:// 用于由 SSL/TLS 安全的 TCP 连接。例如: tcp://localhost:1883 ssl://localhost:8883 如果未指定端口,则为 tcp:// URIs 默认为 1883,对于 ssl:// URIs,8883 为 8883。如果设置了 serverURIs,则它将覆盖 MQTT 客户端构造器上传递的 serverURI 参数。当尝试连接时,客户端将从列表中的第一个 serverURI 开始,并操作列表,直到与服务器建立连接为止。如果无法对任何服务器建立连接,则连接尝试会失败。指定客户端可以连接到多个用途的服务器列表:高可用性和可靠的消息交付一些 MQTT 服务器支持高可用性功能,其中两个或更多 MQTT 服务器共享状态。MQTT 客户端可以连接到任何等同的服务器,并保证无论客户端连接到哪个服务器,都可靠交付和持久化订阅。如果需要 durable 订阅和/或可靠的消息交付,则必须将 cleansession 标志设置为 false。可以指定一组不相等的服务器集合(如高可用性选项中)。因为服务器之间没有共享状态,因此消息交付和持久化订阅无效。如果使用了 hunt 列表模式,则必须将 cleansession 标志设置为 true。

 

字符串

willPayload (common)

为连接设置 Last Will and Testament (LWT)。如果此客户端意外丢失与服务器的连接,服务器将使用提供的详细信息向其自身发布消息。要发布到消息的字节有效负载的主题。发布消息的服务质量(0、1 或 2)。消息是否应保留。

 

字符串

willQos (common)

为连接设置 Last Will and Testament (LWT)。如果此客户端意外丢失与服务器的连接,服务器将使用提供的详细信息向其自身发布消息。要发布到消息的字节有效负载的主题。发布消息的服务质量(0、1 或 2)。消息是否应保留。

 

int

willRetained (common)

为连接设置 Last Will and Testament (LWT)。如果此客户端意外丢失与服务器的连接,服务器将使用提供的详细信息向其自身发布消息。要发布到消息的字节有效负载的主题。发布消息的服务质量(0、1 或 2)。消息是否应保留。

false

布尔值

willTopic (common)

为连接设置 Last Will and Testament (LWT)。如果此客户端意外丢失与服务器的连接,服务器将使用提供的详细信息向其自身发布消息。要发布到消息的字节有效负载的主题。发布消息的服务质量(0、1 或 2)。消息是否应保留。

 

字符串

bridgeErrorHandler (consumer)

允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。

false

布尔值

lazyStartProducer (producer)

生成者是否应懒惰启动 (在第一个消息中)。通过懒惰启动,您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动,并导致路由启动失败。通过懒惰启动,启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意,在处理第一个消息时,创建并启动生成者可能需要稍等时间,并延长处理的总处理时间。

false

布尔值

autowiredEnabled (advanced)

是否启用自动关闭。这用于自动关闭选项(选项必须标记为 autowired),方法是在 registry 中查找查找是否有单个匹配类型实例,然后在组件上配置。这可以用于自动配置 JDBC 数据源、JMS 连接工厂、AWS 客户端等。

true

布尔值

client (advanced)

使用共享 Paho 客户端。

 

MqttClient

customWebSocketHeaders (advanced)

为 WebSocket 连接设置自定义 WebSocket 标头。

 

Properties

executorServiceTimeout (advanced)

设置 executor 服务在强制终止前应等待的时间(以秒为单位)。除非绝对确定您需要修改这个值,否则不建议更改这个值。

1

int

httpsHostnameVerificationEnabled (security)

是否启用 SSL HostnameVerifier。默认值为 true。

true

布尔值

password (security)

用于针对 MQTT 代理进行身份验证的密码。

 

字符串

socketFactory (security)

设置要使用的 SocketFactory。这允许应用程序在创建网络套接字时应用自己的策略。如果使用 SSL 连接,可以使用 SSLSocketFactory 提供应用特定的安全设置。

 

SocketFactory

sslClientProps (security)

设置连接的 SSL 属性。请注意,只有 Java 安全套接字扩展(JSSE)可用时,这些属性才有效。如果设置了自定义 SocketFactory,则不会使用这些属性。可以使用以下属性:com.ibm.ssl.protocol One of: SSL, SSLv3, TLS, TLSv1, SSL_TLS. com.ibm.ssl.contextProvider Underlying JSSE provider.例如,IBMJSSE2 或 SunJSSE com.ibm.ssl.keyStore 是包含您希望 KeyManager 使用的 KeyStore 对象的文件的名称。例如,/mydir/etc/key.p12 com.ibm.ssl.keyStorePassword 是您希望 KeyManager 使用的 KeyStore 对象的密码。密码可以是纯文本,也可以使用静态方法混淆:com.ibm.micro.security.Password.obfuscate (支付密码)。这使用简单不安全的 XOR 和 Base64 编码机制来混淆密码。请注意,这只是一个简单的 scrambler 来混淆明文密码。com.ibm.ssl.keyStoreType Type 为密钥存储,如 PKCS12、JKS 或 JCEKS. com.ibm.ssl.keyStoreProvider Key 存储供应商,如 IBMJCE 或 IBMJCEFIPS. com.ibm.ssl.trustStore 包含您希望 TrustManager 使用的 KeyStore 对象的文件的名称。com.ibm.ssl.trustStorePassword。您想要 TrustStore 对象的 TrustStore 对象的密码。密码可以是纯文本,也可以使用静态方法混淆:com.ibm.micro.security.Password.obfuscate (支付密码)。这使用简单不安全的 XOR 和 Base64 编码机制来混淆密码。请注意,这只是一个简单的 scrambler 来混淆明文密码。com.ibm.ssl.trustStoreType 是您希望默认 TrustManager 使用的 KeyStore 对象类型。与 keyStoreType. com.ibm.ssl.trustStoreProvider Trust store provider 相同的可能值,如 IBMJCE 或 IBMJCEFIPS. com.ibm.ssl.enabledCipherSuites A 列表启用了哪些密码。值依赖于提供程序,例如:SSL_RSA_WITH_AES_128_CBC_SHA;SSL_RSA_WITH_3DES_EDE_CBC_SHA. com.ibm.ssl.keyManager 设置用于实例化 KeyManagerFactory 对象而不是使用平台中提供的默认算法的算法。示例值:IbmX509 或 IBMJ9X509. com.ibm.ssl.trustManager 设置用于实例化 TrustManagerFactory 对象的算法,而不是使用平台中提供的默认算法。示例值:PKIX 或 IBMJ9X509.

 

Properties

sslHostnameVerifier (security)

为 SSL 连接设置 HostnameVerifier。请注意,它将在连接上的握手后使用,您应该在验证主机名错误时自行执行操作。没有默认的 HostnameVerifier。

 

HostnameVerifier

用户名 (安全性)

用于针对 MQTT 代理进行身份验证的用户名。

 

字符串

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.