org.yamcs.api.ws

Class WebSocketClient

java.lang.Object

org.yamcs.api.ws.WebSocketClient

public class WebSocketClient
extends Object

Netty-implementation of a Yamcs web socket client

Constructor Summary

Constructors

Constructor and Description
WebSocketClient(WebSocketClientCallback callback)
WebSocketClient(YamcsConnectionProperties yprops)
WebSocketClient(YamcsConnectionProperties yprops, WebSocketClientCallback callback)

Method Summary

Modifier and Type	Method and Description
io.netty.channel.ChannelFuture	connect()
void	disconnect()
void	enableReconnection(boolean enableReconnection) enable or disable reconnection in case of failure to connect or if the client is disconnected.
void	enableTcpKeepAlive(boolean enableTcpKeepAlive) Enable/disable the TCP Keep-Alive on websocket sockets.
Web.ConnectionInfo	getConnectionInfo()
int	getMaxFramePayloadLength()
boolean	isConnected()
boolean	isInsecureTls()
boolean	isUseProtobuf()
CompletableFuture<Web.WebSocketServerMessage.WebSocketReplyData>	sendRequest(WebSocketRequest request) Performs the request in a different thread
void	sendRequest(WebSocketRequest request, WebSocketResponseHandler responseHandler)
void	setCaCertFile(String caCertFile) In case of https connections, this file contains the CA certificates that are used to verify server certificate
void	setConnectionProperties(YamcsConnectionProperties yprops)
void	setConnectionTimeoutMs(int timeoutMs)
void	setInsecureTls(boolean insecureTls) if true and https connections are used, do not verify server certificate
void	setMaxFramePayloadLength(int maxFramePayloadLength)
void	setReconnectionInterval(long reconnectionIntervalMillisec) set the reconnection interval in milliseconds.
void	setUserAgent(String userAgent)
io.netty.util.concurrent.Future<?>	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketClient

public WebSocketClient(WebSocketClientCallback callback)

WebSocketClient

public WebSocketClient(YamcsConnectionProperties yprops,
                       WebSocketClientCallback callback)

WebSocketClient

public WebSocketClient(YamcsConnectionProperties yprops)

Method Detail

getMaxFramePayloadLength

public int getMaxFramePayloadLength()

setMaxFramePayloadLength

public void setMaxFramePayloadLength(int maxFramePayloadLength)

setConnectionProperties

public void setConnectionProperties(YamcsConnectionProperties yprops)

setUserAgent

public void setUserAgent(String userAgent)

setConnectionTimeoutMs

public void setConnectionTimeoutMs(int timeoutMs)

enableReconnection

public void enableReconnection(boolean enableReconnection)

enable or disable reconnection in case of failure to connect or if the client is disconnected.

Parameters:

enableReconnection -

connect

public io.netty.channel.ChannelFuture connect()
                                       throws SSLException,
                                              GeneralSecurityException

Throws:

SSLException

GeneralSecurityException

setReconnectionInterval

public void setReconnectionInterval(long reconnectionIntervalMillisec)

set the reconnection interval in milliseconds. This value is used when the connection fails and after the client is disconnected. Make sure to use the enableReconnection(boolean) to enable the recconnection.

Parameters:

reconnectionIntervalMillisec -

sendRequest

public CompletableFuture<Web.WebSocketServerMessage.WebSocketReplyData> sendRequest(WebSocketRequest request)

Performs the request in a different thread

Parameters:

request -

Returns:

future that completes when the request is answered

sendRequest

public void sendRequest(WebSocketRequest request,
                        WebSocketResponseHandler responseHandler)

isUseProtobuf

public boolean isUseProtobuf()

disconnect

public void disconnect()

enableTcpKeepAlive

public void enableTcpKeepAlive(boolean enableTcpKeepAlive)

Enable/disable the TCP Keep-Alive on websocket sockets. By default it is disabled. It has to be enabled before the connection is estabilished.

Parameters:

enableTcpKeepAlive - if true the TCP SO_KEEPALIVE option is set

shutdown

public io.netty.util.concurrent.Future<?> shutdown()

Returns:

the Future which is notified when the executor has been terminated.

isConnected

public boolean isConnected()

getConnectionInfo

public Web.ConnectionInfo getConnectionInfo()

setCaCertFile

public void setCaCertFile(String caCertFile)
                   throws IOException,
                          GeneralSecurityException

In case of https connections, this file contains the CA certificates that are used to verify server certificate

Parameters:

caCertFile -

Throws:

IOException

GeneralSecurityException

isInsecureTls

public boolean isInsecureTls()

setInsecureTls

public void setInsecureTls(boolean insecureTls)

if true and https connections are used, do not verify server certificate

Parameters:

insecureTls -