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 -

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 and Description
static org.java_websocket.drafts.Draft	DEFAULT_DRAFT
static java.util.Map<java.lang.String,java.lang.String>	NO_HTTP_HEADERS
static java.net.Proxy	NO_PROXY
protected org.java_websocket.client.WebSocketClient	ws

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected OnInternalError	getOnInternalError() Callback for internal error
boolean	sendMessage(JsonrpcMessage message) Sends a JSON-RPC message.
void	sendMessageOrError(JsonrpcMessage message)
java.util.concurrent.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
void	stop() Stops the websocket client

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

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

Methods inherited from class java.lang.Object

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

Field Detail

NO_HTTP_HEADERS

public static final java.util.Map<java.lang.String,java.lang.String> NO_HTTP_HEADERS

NO_PROXY

public static final java.net.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 Detail

AbstractWebsocketClient

protected AbstractWebsocketClient(java.lang.String name,
                                  java.net.URI serverUri)

AbstractWebsocketClient

protected AbstractWebsocketClient(java.lang.String name,
                                  java.net.URI serverUri,
                                  java.util.Map<java.lang.String,java.lang.String> httpHeaders)

AbstractWebsocketClient

protected AbstractWebsocketClient(java.lang.String name,
                                  java.net.URI serverUri,
                                  java.util.Map<java.lang.String,java.lang.String> httpHeaders,
                                  java.net.Proxy proxy)

AbstractWebsocketClient

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

Method Detail

start

public void start()

Starts the websocket client

startBlocking

public void startBlocking()
                   throws java.lang.InterruptedException

Starts the websocket client

Throws:

java.lang.InterruptedException

stop

public void stop()

Stops the websocket client

getOnInternalError

protected OnInternalError getOnInternalError()

Description copied from class: AbstractWebsocket

Callback for internal error

Specified by:

getOnInternalError in class AbstractWebsocket<T extends WsData>

Returns:

sendMessageOrError

public void sendMessageOrError(JsonrpcMessage message)
                        throws OpenemsException

Throws:

OpenemsException

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 -

Returns:

sendRequest

public java.util.concurrent.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