Package io.openems.common.websocket

Class AbstractWebsocketServer<T extends WsData>

java.lang.Object

io.openems.common.websocket.AbstractWebsocket<T>

io.openems.common.websocket.AbstractWebsocketServer<T>

Direct Known Subclasses:

DummyWebsocketServer, WebsocketServer, WebsocketServer, WebsocketServer, WebsocketServer

public abstract class AbstractWebsocketServer<T extends WsData>
extends AbstractWebsocket<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractWebsocketServer.DebugMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWebsocketServer(String name, int port, int poolSize, AbstractWebsocketServer.DebugMode debugMode)	Construct an AbstractWebsocketServer.

Method Summary

Modifier and Type	Method	Description
void	broadcastMessage(JsonrpcMessage message)	Broadcasts a message to all connected WebSockets.
String	debugLog()	Returns a debug log of the current websocket state.
Map<String,Number>	debugMetrics()	Returns debug metrics of the current websocket state.
protected void	execute(Runnable command)	Execute a Runnable using the shared ExecutorService.
Collection<org.java_websocket.WebSocket>	getConnections()
protected OnInternalError	getOnInternalError()	Callback for internal error.
int	getPort()	Gets the port number that this server listens on.
protected JsonrpcMessage	handleNonJsonrpcMessage(org.java_websocket.WebSocket ws, String stringMessage, OpenemsError.OpenemsNamedException e)	Handle Non-JSON-RPC messages.
void	sendMessage(org.java_websocket.WebSocket ws, JsonrpcMessage message)	Sends a message to WebSocket.
void	start()	Starts the websocket server.
void	stop()	Stops the websocket server.

Methods inherited from class io.openems.common.websocket.AbstractWebsocket

createWsData, getName, getOnClose, getOnError, getOnNotification, getOnOpen, getOnRequest, handleInternalErrorAsync, handleInternalErrorSync, logError, logInfo, logWarn

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractWebsocketServer

protected AbstractWebsocketServer(String name,
 int port,
 int poolSize,
 AbstractWebsocketServer.DebugMode debugMode)

Construct an AbstractWebsocketServer.

Parameters:

name - to identify this server

port - to listen on

poolSize - number of threads dedicated to handle the tasks

debugMode - activate a regular debug log about the state of the tasks

Method Details

debugLog

public String debugLog()

Returns a debug log of the current websocket state.

Returns:

the debug log string

debugMetrics

public Map<String,Number> debugMetrics()

Returns debug metrics of the current websocket state.

Returns:

the debug metrics

getOnInternalError

protected OnInternalError getOnInternalError()

Description copied from class: AbstractWebsocket

Callback for internal error.

Specified by:

getOnInternalError in class AbstractWebsocket<T extends WsData>

Returns:

the OnInternalError callback

getConnections

public Collection<org.java_websocket.WebSocket> getConnections()

sendMessage

public void sendMessage(org.java_websocket.WebSocket ws,
 JsonrpcMessage message)

Sends a message to WebSocket.

Parameters:

ws - the WebSocket

message - the JSON-RPC Message

broadcastMessage

public void broadcastMessage(JsonrpcMessage message)

Broadcasts a message to all connected WebSockets.

Parameters:

message - the JSON-RPC Message

getPort

public int getPort()

Gets the port number that this server listens on.

Returns:

The port number.

start

public void start()

Starts the websocket server.

Overrides:

start in class AbstractWebsocket<T extends WsData>

execute

protected void execute(Runnable command)

Execute a Runnable using the shared ExecutorService.

Specified by:

execute in class AbstractWebsocket<T extends WsData>

Parameters:

command - the Runnable

stop

public void stop()

Stops the websocket server.

Overrides:

stop in class AbstractWebsocket<T extends WsData>

handleNonJsonrpcMessage

protected JsonrpcMessage handleNonJsonrpcMessage(org.java_websocket.WebSocket ws,
 String stringMessage,
 OpenemsError.OpenemsNamedException e)
                                          throws OpenemsError.OpenemsNamedException

Handle Non-JSON-RPC messages.

Parameters:

ws - the WebSocket

stringMessage - the message

e - the parse error

Returns:

message converted to JsonrpcMessage; or null

Throws:

OpenemsError.OpenemsNamedException - if conversion is not possible