Package org.apache.camel.builder.endpoint.dsl

Class VertxWebsocketEndpointBuilderFactory.VertxWebsocketHeaderNameBuilder

java.lang.Object

org.apache.camel.builder.endpoint.dsl.VertxWebsocketEndpointBuilderFactory.VertxWebsocketHeaderNameBuilder

Enclosing interface:

VertxWebsocketEndpointBuilderFactory

public static class VertxWebsocketEndpointBuilderFactory.VertxWebsocketHeaderNameBuilder
extends Object

The builder of headers' name for the Vert.x WebSocket component.

Constructor Summary

Constructors

Constructor	Description
VertxWebsocketHeaderNameBuilder()

Method Summary

Modifier and Type	Method	Description
String	vertxwebsocketConnectionkey()	Sends the message to the client with the given connection key.
String	vertxwebsocketRemoteaddress()	The remote address.
String	vertxwebsocketSendtoall()	Sends the message to all clients which are currently connected.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VertxWebsocketHeaderNameBuilder

public VertxWebsocketHeaderNameBuilder()

Method Detail

vertxwebsocketConnectionkey

public String vertxwebsocketConnectionkey()

Sends the message to the client with the given connection key. You can use a comma separated list of keys to send a message to multiple clients. The option is a: String type. Group: common

Returns:

the name of the header VertxWebsocket.connectionKey.

vertxwebsocketSendtoall

public String vertxwebsocketSendtoall()

Sends the message to all clients which are currently connected. You can use the sendToAll option on the endpoint instead of using this header. The option is a: boolean type. Group: producer

Returns:

the name of the header VertxWebsocket.sendToAll.

vertxwebsocketRemoteaddress

public String vertxwebsocketRemoteaddress()

The remote address. The option is a: io.vertx.core.net.SocketAddress type. Group: consumer

Returns:

the name of the header VertxWebsocket.remoteAddress.