Package org.openremote.agent.protocol.websocket

Class WebsocketIOClient<T>

java.lang.Object

org.openremote.agent.protocol.io.AbstractNettyIOClient<T,InetSocketAddress>

org.openremote.agent.protocol.websocket.WebsocketIOClient<T>

All Implemented Interfaces:

IOClient<T>, NettyIOClient<T>

public class WebsocketIOClient<T>
extends AbstractNettyIOClient<T,InetSocketAddress>

This is an IOClient implementation based on AbstractNettyIOClient. For custom decoders, the initial message type is of type String. For custom encoders, the final message type must be of type String.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	WebsocketIOClient.WebSocketClientHandler	Extracts the text from the WebSocketFrame and sends it to the next handler in the pipeline

Nested classes/interfaces inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClient

AbstractNettyIOClient.ByteToMessageDecoder<T>, AbstractNettyIOClient.MessageToByteEncoder<T>, AbstractNettyIOClient.MessageToMessageDecoder<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	authHeaderValue
protected CompletableFuture<Boolean>	connectedFuture
protected WebsocketIOClient<T>.WebSocketClientHandler	handler
protected Map<String,List<String>>	headers
protected String	host
protected org.openremote.model.auth.OAuthGrant	oAuthGrant
protected int	port
protected io.netty.handler.ssl.SslContext	sslCtx
protected URI	uri
protected boolean	useSsl

Fields inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClient

bootstrap, channel, channelStartFuture, connectionStatus, connectionStatusConsumers, connectRetry, encoderDecoderProvider, executorService, messageConsumers, permanentError, RECONNECT_DELAY_INITIAL_MILLIS, RECONNECT_DELAY_MAX_MILLIS, workerGroup

Constructor Summary

Constructors

Constructor	Description
WebsocketIOClient(URI uri, Map<String,List<String>> headers, org.openremote.model.auth.OAuthGrant oAuthGrant)

Method Summary

Modifier and Type	Method	Description
protected void	addEncodersDecoders(io.netty.channel.Channel channel)
protected CompletableFuture<Boolean>	createConnectedFuture()
protected Future<Boolean>	doConnect()
protected Class<? extends io.netty.channel.Channel>	getChannelClass()
String	getClientUri()	Should return a URI that uniquely identifies this client instance
protected io.netty.channel.EventLoopGroup	getWorkerGroup()
protected void	initChannel(io.netty.channel.Channel channel)	Inserts the decoders and encoders into the channel pipeline
protected void	onHandshakeComplete(io.netty.channel.ChannelFuture handshakeFuture)
protected io.netty.channel.ChannelFuture	startChannel()

Methods inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClient

addConnectionStatusConsumer, addMessageConsumer, configureChannel, connect, disconnect, doDisconnect, getConnectionStatus, onConnectedFutureComplete, onConnectionStatusChanged, onDecodeException, onEncodeException, onMessageReceived, removeAllConnectionStatusConsumers, removeAllMessageConsumers, removeConnectionStatusConsumer, removeMessageConsumer, scheduleDoConnect, sendMessage, setEncoderDecoderProvider, setPermanentError, toString

Methods inherited from class java.lang.Object

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

Field Details

useSsl

protected boolean useSsl

uri

protected URI uri

sslCtx

protected io.netty.handler.ssl.SslContext sslCtx

handler

protected WebsocketIOClient<T>.WebSocketClientHandler handler

headers

protected Map<String,List<String>> headers

oAuthGrant

protected org.openremote.model.auth.OAuthGrant oAuthGrant

authHeaderValue

protected String authHeaderValue

host

protected String host

port

protected int port

connectedFuture

protected CompletableFuture<Boolean> connectedFuture

Constructor Details

WebsocketIOClient

public WebsocketIOClient(URI uri,
 Map<String,List<String>> headers,
 org.openremote.model.auth.OAuthGrant oAuthGrant)

Method Details

getChannelClass

protected Class<? extends io.netty.channel.Channel> getChannelClass()

Specified by:

getChannelClass in class AbstractNettyIOClient<T,InetSocketAddress>

getClientUri

public String getClientUri()

Description copied from interface: IOClient

Should return a URI that uniquely identifies this client instance

getWorkerGroup

protected io.netty.channel.EventLoopGroup getWorkerGroup()

Specified by:

getWorkerGroup in class AbstractNettyIOClient<T,InetSocketAddress>

startChannel

protected io.netty.channel.ChannelFuture startChannel()

Specified by:

startChannel in class AbstractNettyIOClient<T,InetSocketAddress>

initChannel

protected void initChannel(io.netty.channel.Channel channel)

Description copied from class: AbstractNettyIOClient

Inserts the decoders and encoders into the channel pipeline

Overrides:

initChannel in class AbstractNettyIOClient<T,InetSocketAddress>

onHandshakeComplete

protected void onHandshakeComplete(io.netty.channel.ChannelFuture handshakeFuture)

addEncodersDecoders

protected void addEncodersDecoders(io.netty.channel.Channel channel)

Overrides:

addEncodersDecoders in class AbstractNettyIOClient<T,InetSocketAddress>

doConnect

protected Future<Boolean> doConnect()

Overrides:

doConnect in class AbstractNettyIOClient<T,InetSocketAddress>

createConnectedFuture

protected CompletableFuture<Boolean> createConnectedFuture()

Overrides:

createConnectedFuture in class AbstractNettyIOClient<T,InetSocketAddress>