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:

WebsocketServer, WebsocketServer, WebsocketServer, WebsocketServer

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWebsocketServer(java.lang.String name, int port)

Method Summary

Modifier and Type	Method and Description
void	broadcastMessage(JsonrpcMessage message) Broadcasts a message to all connected WebSockets.
java.util.Collection<org.java_websocket.WebSocket>	getConnections()
protected OnInternalError	getOnInternalError() Callback for internal error
protected JsonrpcMessage	handleNonJsonrpcMessage(java.lang.String stringMessage, OpenemsError.OpenemsNamedException e) Convert deprecated Non-JSON-RPC messages to 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, logInfo, logWarn

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWebsocketServer

protected AbstractWebsocketServer(java.lang.String name,
                                  int port)

Parameters:

name - to identify this server

port - to listen on

Method Detail

getOnInternalError

protected OnInternalError getOnInternalError()

Description copied from class: AbstractWebsocket

Callback for internal error

Specified by:

getOnInternalError in class AbstractWebsocket<T extends WsData>

Returns:

getConnections

public java.util.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

start

public void start()

Starts the websocket server

stop

public void stop()

Stops the websocket server

handleNonJsonrpcMessage

protected JsonrpcMessage handleNonJsonrpcMessage(java.lang.String stringMessage,
                                                 OpenemsError.OpenemsNamedException e)
                                          throws OpenemsError.OpenemsNamedException

Convert deprecated Non-JSON-RPC messages to JSON-RPC messages.

Parameters:

stringMessage -

Returns:

Throws:

OpenemsError.OpenemsNamedException