UiWebsocket (OpenEMS Javadoc)

All Known Implementing Classes:: UiWebsocketImpl

@ProviderType public interface UiWebsocket

Method Summary

Modifier and Type

Method

Description

void

send(String token, JsonrpcNotification notification)

Send a JSON-RPC Notification to a UI session.

CompletableFuture<JsonrpcResponseSuccess>

send(String token, JsonrpcRequest request)

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

void

sendBroadcast(String edgeId, JsonrpcNotification notification)

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

void

sendSubscribedChannels(String edgeId, EdgeCache edgeCache)

Sends the subscribed Channels to the UI session.

Method Details
- send
  
  CompletableFuture<JsonrpcResponseSuccess> send(String 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(String 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
- sendBroadcast
  
  void sendBroadcast(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
- sendSubscribedChannels
  
  void sendSubscribedChannels(String edgeId, EdgeCache edgeCache)
  
  Sends the subscribed Channels to the UI session.
  
  Parameters:
  
  edgeId - the Edge-ID
  
  edgeCache - the EdgeCache for the Edge-ID