io.openems.backend.uiwebsocket.impl

Class UiWebsocketImpl

java.lang.Object

io.openems.backend.common.component.AbstractOpenemsBackendComponent

io.openems.backend.uiwebsocket.impl.UiWebsocketImpl

All Implemented Interfaces:

UiWebsocket

public class UiWebsocketImpl
extends AbstractOpenemsBackendComponent
implements UiWebsocket

Field Summary

Fields

Modifier and Type	Field and Description
protected EdgeWebsocket	edgeWebsocket
protected JsonRpcRequestHandler	jsonRpcRequestHandler
protected Metadata	metadata
protected WebsocketServer	server
protected Timedata	timeData

Constructor Summary

Constructors

Constructor and Description
UiWebsocketImpl()

Method Summary

Modifier and Type	Method and Description
protected void	logInfo(org.slf4j.Logger log, java.lang.String message) Log an info message including the Component ID.
protected void	logWarn(org.slf4j.Logger log, java.lang.String message) Log a warn message including the Component ID.
void	send(java.lang.String edgeId, JsonrpcNotification notification) Send a JSON-RPC Notification broadcast to all UI sessions with a given Edge-ID.
void	send(java.util.UUID token, JsonrpcNotification notification) Send a JSON-RPC Notification to a UI session.
java.util.concurrent.CompletableFuture<JsonrpcResponseSuccess>	send(java.util.UUID token, JsonrpcRequest request) Send a JSON-RPC Request to a UI session via WebSocket and expect a JSON-RPC Response.

Methods inherited from class io.openems.backend.common.component.AbstractOpenemsBackendComponent

getName, logDebug, logError

Methods inherited from class java.lang.Object

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

Field Detail

server

protected WebsocketServer server

jsonRpcRequestHandler

protected volatile JsonRpcRequestHandler jsonRpcRequestHandler

metadata

protected volatile Metadata metadata

edgeWebsocket

protected volatile EdgeWebsocket edgeWebsocket

timeData

protected volatile Timedata timeData

Constructor Detail

UiWebsocketImpl

public UiWebsocketImpl()

Method Detail

logInfo

protected void logInfo(org.slf4j.Logger log,
                       java.lang.String message)

Description copied from class: AbstractOpenemsBackendComponent

Log an info message including the Component ID.

Overrides:

logInfo in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Info-message

logWarn

protected void logWarn(org.slf4j.Logger log,
                       java.lang.String message)

Description copied from class: AbstractOpenemsBackendComponent

Log a warn message including the Component ID.

Overrides:

logWarn in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Warn-message

send

public void send(java.util.UUID token,
                 JsonrpcNotification notification)
          throws OpenemsError.OpenemsNamedException

Description copied from interface: UiWebsocket

Send a JSON-RPC Notification to a UI session.

Specified by:

send in interface UiWebsocket

Parameters:

token - the UI token

notification - the JsonrpcNotification

Throws:

OpenemsError.OpenemsNamedException - on error

send

public java.util.concurrent.CompletableFuture<JsonrpcResponseSuccess> send(java.util.UUID token,
                                                                           JsonrpcRequest request)
                                                                    throws OpenemsError.OpenemsNamedException

Description copied from interface: UiWebsocket

Send a JSON-RPC Request to a UI session via WebSocket and expect a JSON-RPC Response.

Specified by:

send in interface UiWebsocket

Parameters:

token - the UI token

request - the JsonrpcRequest

Returns:

the JSON-RPC Success Response Future

Throws:

OpenemsError.OpenemsNamedException - on error

send

public void send(java.lang.String edgeId,
                 JsonrpcNotification notification)
          throws OpenemsError.OpenemsNamedException

Description copied from interface: UiWebsocket

Send a JSON-RPC Notification broadcast to all UI sessions with a given Edge-ID.

Specified by:

send in interface UiWebsocket

Parameters:

edgeId - the Edge-ID

notification - the JsonrpcNotification

Throws:

OpenemsError.OpenemsNamedException - on error