151.5. 端点选项

host (common)

在客户端模式中，所需的 WebSocket 主机名，如 localhost 或远程主机。

字符串

port (common)

必需的 WebSocket 端口号。

int

path (common)

要使用的 websocket 路径。

字符串

allowedOriginPattern (consumer)

与 WebSocket 客户端发送的原始标头匹配的正则表达式。

字符串

allowOriginHeader (consumer)

WebSocket 客户端是否应该将 Origin 标头添加到 WebSocket 握手请求中。

true

布尔值

consumeAsClient (consumer)

当设置为 true 时，消费者充当 WebSocket 客户端，在每个收到的 WebSocket 事件上创建交换。

false

布尔值

fireWebSocketConnectionEvents (consumer)

当新的 WebSocket peer 连接或断开连接时，服务器消费者是否会创建消息交换。

false

布尔值

maxReconnectAttempts (consumer)

当 consumeAsClient 设置为 true 时，这将设置允许重新连接之前关闭的 WebSocket 的最大次数。值 0 （默认值）将尝试无限期重新连接。

0

int

originHeaderUrl (consumer)

WebSocket 客户端应在 WebSocket 握手请求上使用的 Origin 标头的值。如果没有指定，WebSocket 客户端将自动从请求 URL 确定 Origin 的值。

字符串

reconnectInitialDelay (consumer)

当 consumeAsClient 设置为 true 时，这会在尝试重新连接到之前关闭的 WebSocket 前设置初始延迟（以毫秒为单位）。

0

int

reconnectInterval (consumer)

当 consumeAsClient 设置为 true 时，这会设置重新连接之前关闭 WebSocket 的时间间隔（以毫秒为单位）。

1000

int

router (consumer)

将现有的 vertx 路由器用于 HTTP 服务器。

路由器

serverOptions (consumer)

设置用于为使用者配置 WebSocket 的 HTTP 服务器的自定义选项。

HttpServerOptions

bridgeErrorHandler (consumer (advanced))

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

false

布尔值

exceptionHandler (consumer (advanced))

要让使用者使用自定义例外处理程序：请注意，如果启用了 bridgeErrorHandler 选项，则此选项不使用。默认情况下，消费者将处理异常，其记录在 WARN 或 ERROR 级别中，并忽略。

ExceptionHandler

exchangePattern (consumer (advanced))

在消费者创建交换时设置交换模式。

Enum 值：

ExchangePattern

clientOptions (producer)

设置用于配置制作者中使用的 WebSocket 客户端的自定义选项。

HttpClientOptions

clientSubProtocols (producer)

以逗号分隔的 WebSocket 子协议列表，客户端应该用于 Sec-WebSocket-Protocol 标头。

字符串

sendToAll (producer)

发送到所有 websocket 订阅者。可用于在端点级别上配置，而不是在消息上提供 VertxWebsocketConstants.SEND_TO_ALL 标头。请注意，使用这个选项时，为 vertx-websocket producer URI 指定的主机名必须与用于现有 vertx-websocket 使用者的主机名匹配。请注意，这个选项只适用于生成消息到 vertx-websocket consumer 托管的端点，而不是外部托管的 WebSocket。

false

布尔值

lazyStartProducer (producer (advanced))

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

false

布尔值

sslContextParameters (security)

使用 SSLContextParameters 配置安全性。

SSLContextParameters