Package io.openems.common.jsonrpc.request

Class SubscribeChannelsRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.common.jsonrpc.request.SubscribeChannelsRequest

public class SubscribeChannelsRequest
extends JsonrpcRequest

Represents a JSON-RPC Request to subscribe to Channels.

This is used by UI to get regular updates on specific channels.

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

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
SubscribeChannelsRequest(int count)

Method Summary

Modifier and Type	Method	Description
static SubscribeChannelsRequest	from(JsonrpcRequest r)	Create SubscribeChannelsRequest from a template JsonrpcRequest.
TreeSet<String>	getChannels()	Gets the set of ChannelAddresses.
int	getCount()	Gets the Count value.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

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, 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

SubscribeChannelsRequest

public SubscribeChannelsRequest(int count)

Method Details

from

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

Create SubscribeChannelsRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the SubscribeChannelsRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

getCount

public int getCount()

Gets the Count value.

This value is increased with every request to assure order.

Returns:

the count value

getChannels

public TreeSet<String> getChannels()

Gets the set of ChannelAddresses.

Returns:

the ChannelAddresses

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