io.openems.backend.uiwebsocket.api

Interface UiWebsocket

All Known Implementing Classes:

UiWebsocketImpl

@ProviderType
public interface UiWebsocket

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

send

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

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

Parameters:

token - the UI token

request - the JsonrpcRequest

Returns:

the JSON-RPC Success Response Future

Throws:

OpenemsError.OpenemsNamedException - on error

send

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

Send a JSON-RPC Notification to a UI session.

Parameters:

token - the UI token

notification - the JsonrpcNotification

Throws:

OpenemsError.OpenemsNamedException - on error

send

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

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

Parameters:

edgeId - the Edge-ID

notification - the JsonrpcNotification

Throws:

OpenemsError.OpenemsNamedException - on error