Package io.openems.backend.b2bwebsocket.jsonrpc.request

Class SubscribeEdgesChannelsRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.backend.b2bwebsocket.jsonrpc.request.SubscribeEdgesChannelsRequest

public class SubscribeEdgesChannelsRequest
extends JsonrpcRequest

Represents a JSON-RPC Request to subscribe to Channels of multiple Edges.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "subscribeEdgesChannels",
   "params": {
     "count": number // Request-Counter: the higher count wins
     "edgeIds": string[] // Edge-IDs
     "channels": string[] // Channel-IDs
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

DEFAULT_TIMEOUT_SECONDS, id, NO_TIMEOUT, timeoutOpt

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
SubscribeEdgesChannelsRequest(int count)

Method Summary

Modifier and Type	Method	Description
void	addChannel(ChannelAddress address)	Adds a Channel.
void	addEdgeId(String edgeId)	Adds an Edge-ID.
static SubscribeEdgesChannelsRequest	from(com.google.gson.JsonObject j)	Builds a SubscribeEdgesChannelsRequest from a JsonObject.
static SubscribeEdgesChannelsRequest	from(JsonrpcRequest r)	Builds a SubscribeEdgesChannelsRequest from a JsonrpcRequest.
TreeSet<ChannelAddress>	getChannels()
int	getCount()
TreeSet<String>	getEdgeIds()
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
void	removeEdgeId(String edgeId)	Removes an Edge-ID.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcRequest

getId, getTimeout, toJsonObject

Methods inherited from class io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

getFullyQualifiedMethod, getMethod

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

from, toString

Methods inherited from class java.lang.Object

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

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

Constructor Details

SubscribeEdgesChannelsRequest

public SubscribeEdgesChannelsRequest(int count)

Method Details

from

public static SubscribeEdgesChannelsRequest from(JsonrpcRequest r)
                                          throws OpenemsError.OpenemsNamedException

Builds a SubscribeEdgesChannelsRequest from a JsonrpcRequest.

Parameters:

r - the JsonrpcRequest

Returns:

the SubscribeEdgesChannelsRequest

Throws:

OpenemsError.OpenemsNamedException - on error

from

public static SubscribeEdgesChannelsRequest from(com.google.gson.JsonObject j)
                                          throws OpenemsError.OpenemsNamedException

Builds a SubscribeEdgesChannelsRequest from a JsonObject.

Parameters:

j - the JsonObject

Returns:

the SubscribeEdgesChannelsRequest

Throws:

OpenemsError.OpenemsNamedException - on error

addEdgeId

public void addEdgeId(String edgeId)

Adds an Edge-ID.

Parameters:

edgeId - the Edge-ID.

removeEdgeId

public void removeEdgeId(String edgeId)

Removes an Edge-ID.

Parameters:

edgeId - the Edge-ID

getEdgeIds

public TreeSet<String> getEdgeIds()

addChannel

public void addChannel(ChannelAddress address)

Adds a Channel.

Parameters:

address - the ChannelAddress

getCount

public int getCount()

getChannels

public TreeSet<ChannelAddress> getChannels()

getParams

public com.google.gson.JsonObject getParams()

Description copied from class: AbstractJsonrpcRequest

Gets the params JsonObject of the JsonrpcRequest.

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject