Package io.openems.common.websocket

Class AbstractWebsocketClient<T extends WsData>

java.lang.Object

io.openems.common.websocket.AbstractWebsocket<T>

io.openems.common.websocket.AbstractWebsocketClient<T>

Type Parameters:

T - the type of websocket attachments inheriting WsData

Direct Known Subclasses:

WebsocketClient

public abstract class AbstractWebsocketClient<T extends WsData>
extends AbstractWebsocket<T>

A Websocket Client implementation that automatically tries to reconnect a closed connection.

Field Summary

Fields

Modifier and Type	Field	Description
static final org.java_websocket.drafts.Draft	DEFAULT_DRAFT
static final Map<String,String>	NO_HTTP_HEADERS
static final Proxy	NO_PROXY
protected final org.java_websocket.client.WebSocketClient	ws

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWebsocketClient(String name, URI serverUri)
protected	AbstractWebsocketClient(String name, URI serverUri, Map<String,String> httpHeaders)
protected	AbstractWebsocketClient(String name, URI serverUri, Map<String,String> httpHeaders, Proxy proxy)
protected	AbstractWebsocketClient(String name, URI serverUri, org.java_websocket.drafts.Draft draft, Map<String,String> httpHeaders, Proxy proxy)

Method Summary

Modifier and Type	Method	Description
protected OnInternalError	getOnInternalError()	Callback for internal error.
boolean	sendMessage(JsonrpcMessage message)	Sends a JSON-RPC message.
void	sendMessageOrError(JsonrpcMessage message)	Sends a JsonrpcMessage.
CompletableFuture<JsonrpcResponseSuccess>	sendRequest(JsonrpcRequest request)	Sends a JSON-RPC Request and returns a future Response.
void	start()	Starts the websocket client.
void	startBlocking()	Starts the websocket client; waiting till it started.
void	stop()	Stops the websocket client.

Methods inherited from class io.openems.common.websocket.AbstractWebsocket

createWsData, execute, getName, getOnClose, getOnError, getOnNotification, getOnOpen, getOnRequest, handleInternalErrorAsync, handleInternalErrorSync, logError, logInfo, logWarn

Methods inherited from class java.lang.Object

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

Field Details

NO_HTTP_HEADERS

public static final Map<String,String> NO_HTTP_HEADERS

NO_PROXY

public static final Proxy NO_PROXY

DEFAULT_DRAFT

public static final org.java_websocket.drafts.Draft DEFAULT_DRAFT

ws

protected final org.java_websocket.client.WebSocketClient ws

Constructor Details

AbstractWebsocketClient

protected AbstractWebsocketClient(String name,
 URI serverUri)

AbstractWebsocketClient

protected AbstractWebsocketClient(String name,
 URI serverUri,
 Map<String,String> httpHeaders)

AbstractWebsocketClient

protected AbstractWebsocketClient(String name,
 URI serverUri,
 Map<String,String> httpHeaders,
 Proxy proxy)

AbstractWebsocketClient

protected AbstractWebsocketClient(String name,
 URI serverUri,
 org.java_websocket.drafts.Draft draft,
 Map<String,String> httpHeaders,
 Proxy proxy)

Method Details

start

public void start()

Starts the websocket client.

Overrides:

start in class AbstractWebsocket<T extends WsData>

startBlocking

public void startBlocking()
                   throws InterruptedException

Starts the websocket client; waiting till it started.

Throws:

InterruptedException - on waiting error

stop

public void stop()

Stops the websocket client.

Overrides:

stop in class AbstractWebsocket<T extends WsData>

getOnInternalError

protected OnInternalError getOnInternalError()

Description copied from class: AbstractWebsocket

Callback for internal error.

Specified by:

getOnInternalError in class AbstractWebsocket<T extends WsData>

Returns:

the OnInternalError callback

sendMessageOrError

public void sendMessageOrError(JsonrpcMessage message)
                        throws OpenemsException

Sends a JsonrpcMessage.

Parameters:

message - the JsonrpcMessage

Throws:

OpenemsException - on error, e.g. if the websocket is not connected

sendMessage

public boolean sendMessage(JsonrpcMessage message)

Sends a JSON-RPC message. Returns true if sending was successful, otherwise false. Also logs a warning in that case.

Parameters:

message - the JsonrpcMessage.

Returns:

true if sending was successful

sendRequest

public CompletableFuture<JsonrpcResponseSuccess> sendRequest(JsonrpcRequest request)
                                                      throws OpenemsError.OpenemsNamedException

Sends a JSON-RPC Request and returns a future Response.

Parameters:

request - the JSON-RPC Request

Returns:

the future JSON-RPC Response

Throws:

OpenemsError.OpenemsNamedException - on error