Package io.openems.backend.edgewebsocket

Class WebsocketServer

java.lang.Object

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

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

io.openems.backend.edgewebsocket.WebsocketServer

public class WebsocketServer
extends AbstractWebsocketServer<WsData>

Nested Class Summary

Nested classes/interfaces inherited from class io.openems.common.websocket.AbstractWebsocketServer

AbstractWebsocketServer.DebugMode

Constructor Summary

Constructors

Constructor	Description
WebsocketServer(EdgeWebsocketImpl parent, String name, int port, int poolSize, AbstractWebsocketServer.DebugMode debugMode)

Method Summary

Modifier and Type	Method	Description
protected WsData	createWsData()	Creates an empty WsData object that is attached to the WebSocket as early as possible.
protected OnClose	getOnClose()	Callback for websocket OnClose event.
protected OnError	getOnError()	Callback for websocket error.
OnNotification	getOnNotification()	Callback for JSON-RPC notification.
protected OnOpen	getOnOpen()	Callback for websocket OnOpen event.
protected OnRequest	getOnRequest()	Callback for JSON-RPC request.
protected JsonrpcMessage	handleNonJsonrpcMessage(org.java_websocket.WebSocket ws, String stringMessage, OpenemsError.OpenemsNamedException lastException)	Handle Non-JSON-RPC messages.
boolean	isOnline(String edgeId)	Is the given Edge online?.
protected void	logError(org.slf4j.Logger log, String message)	Log a error message.
protected void	logInfo(org.slf4j.Logger log, String message)	Log a info message.
protected void	logWarn(org.slf4j.Logger log, String message)	Log a warn message.

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

broadcastMessage, execute, getConnections, getOnInternalError, getPort, sendMessage, start, stop

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

getName, handleInternalErrorAsync, handleInternalErrorSync

Methods inherited from class java.lang.Object

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

Constructor Details

WebsocketServer

public WebsocketServer(EdgeWebsocketImpl parent,
 String name,
 int port,
 int poolSize,
 AbstractWebsocketServer.DebugMode debugMode)

Method Details

createWsData

protected WsData createWsData()

Description copied from class: AbstractWebsocket

Creates an empty WsData object that is attached to the WebSocket as early as possible.

Specified by:

createWsData in class AbstractWebsocket<WsData>

Returns:

the typed WsData

isOnline

public boolean isOnline(String edgeId)

Is the given Edge online?.

Parameters:

edgeId - the Edge-ID

Returns:

true if it is online.

getOnOpen

protected OnOpen getOnOpen()

Description copied from class: AbstractWebsocket

Callback for websocket OnOpen event.

Specified by:

getOnOpen in class AbstractWebsocket<WsData>

Returns:

the OnOpen callback

getOnRequest

protected OnRequest getOnRequest()

Description copied from class: AbstractWebsocket

Callback for JSON-RPC request.

Specified by:

getOnRequest in class AbstractWebsocket<WsData>

Returns:

the OnRequest callback

getOnNotification

public OnNotification getOnNotification()

Description copied from class: AbstractWebsocket

Callback for JSON-RPC notification.

Specified by:

getOnNotification in class AbstractWebsocket<WsData>

Returns:

the OnNotification callback

getOnError

protected OnError getOnError()

Description copied from class: AbstractWebsocket

Callback for websocket error.

Specified by:

getOnError in class AbstractWebsocket<WsData>

Returns:

the OnError callback

getOnClose

protected OnClose getOnClose()

Description copied from class: AbstractWebsocket

Callback for websocket OnClose event.

Specified by:

getOnClose in class AbstractWebsocket<WsData>

Returns:

the OnClose callback

handleNonJsonrpcMessage

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

Description copied from class: AbstractWebsocketServer

Handle Non-JSON-RPC messages.

Overrides:

handleNonJsonrpcMessage in class AbstractWebsocketServer<WsData>

Parameters:

ws - the WebSocket

stringMessage - the message

lastException - the parse error

Returns:

message converted to JsonrpcMessage; or null

Throws:

OpenemsError.OpenemsNamedException - if conversion is not possible

logInfo

protected void logInfo(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractWebsocket

Log a info message.

Specified by:

logInfo in class AbstractWebsocket<WsData>

Parameters:

log - a Logger instance

message - the message

logWarn

protected void logWarn(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractWebsocket

Log a warn message.

Specified by:

logWarn in class AbstractWebsocket<WsData>

Parameters:

log - a Logger instance

message - the message

logError

protected void logError(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractWebsocket

Log a error message.

Specified by:

logError in class AbstractWebsocket<WsData>

Parameters:

log - a Logger instance

message - the message