Package io.openems.backend.common.edgewebsocket

Interface EdgeWebsocket

All Known Implementing Classes:

EdgeWebsocketImpl

@ProviderType
public interface EdgeWebsocket

Method Summary

Modifier and Type	Method	Description
Map<ChannelAddress,com.google.gson.JsonElement>	getChannelValues(String edgeId, Set<ChannelAddress> channelAddresses)	Gets the latest values for the given ChannelAddresses.
CompletableFuture<JsonrpcResponseSuccess>	handleSubscribeSystemLogRequest(String edgeId, User user, String token, SubscribeSystemLogRequest request)	Handles a SubscribeSystemLogRequest.
CompletableFuture<JsonrpcResponseSuccess>	send(String edgeId, User user, JsonrpcRequest request)	Send an authenticated JSON-RPC Request to an Edge via Websocket and expect a JSON-RPC Response.
void	send(String edgeId, JsonrpcNotification notification)	Send a JSON-RPC Notification to an Edge.

Method Details

send

CompletableFuture<JsonrpcResponseSuccess> send(String edgeId,
 User user,
 JsonrpcRequest request)
                                        throws OpenemsError.OpenemsNamedException

Send an authenticated JSON-RPC Request to an Edge via Websocket and expect a JSON-RPC Response.

Parameters:

edgeId - the Edge-ID

user - the authenticated User

request - the JsonrpcRequest

Returns:

the JSON-RPC Success Response Future

Throws:

OpenemsError.OpenemsNamedException - on error

send

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

Send a JSON-RPC Notification to an Edge.

Parameters:

edgeId - the Edge-ID

notification - the JsonrpcNotification

Throws:

OpenemsError.OpenemsNamedException - on error

handleSubscribeSystemLogRequest

CompletableFuture<JsonrpcResponseSuccess> handleSubscribeSystemLogRequest(String edgeId,
 User user,
 String token,
 SubscribeSystemLogRequest request)
                                                                   throws OpenemsError.OpenemsNamedException

Handles a SubscribeSystemLogRequest.

Parameters:

edgeId - the Edge-ID

user - the User

token - the UI session token

request - the SubscribeSystemLogRequest

Returns:

a reply

Throws:

OpenemsError.OpenemsNamedException - on error

getChannelValues

Map<ChannelAddress,com.google.gson.JsonElement> getChannelValues(String edgeId,
 Set<ChannelAddress> channelAddresses)

Gets the latest values for the given ChannelAddresses.

Parameters:

edgeId - The unique Edge-ID

channelAddresses - The ChannelAddresses

Returns:

the values; possibly JsonNull