Class WebsocketServer
- java.lang.Object
-
- io.openems.common.websocket.AbstractWebsocket<T>
-
- io.openems.common.websocket.AbstractWebsocketServer<WsData>
-
- io.openems.backend.uiwebsocket.impl.WebsocketServer
-
public class WebsocketServer extends AbstractWebsocketServer<WsData>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class io.openems.common.websocket.AbstractWebsocketServer
AbstractWebsocketServer.DebugMode
-
-
Field Summary
Fields Modifier and Type Field Description protected UiWebsocketImpl
parent
-
Constructor Summary
Constructors Constructor Description WebsocketServer(UiWebsocketImpl parent, java.lang.String name, int port, int poolSize, AbstractWebsocketServer.DebugMode debugMode)
-
Method Summary
All Methods Instance Methods Concrete Methods 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, java.lang.String stringMessage, OpenemsError.OpenemsNamedException lastException)
Handle Non-JSON-RPC messages.protected void
logError(org.slf4j.Logger log, java.lang.String message)
Log a error message.protected void
logInfo(org.slf4j.Logger log, java.lang.String message)
Log a info message.protected void
logWarn(org.slf4j.Logger log, java.lang.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
-
-
-
-
Field Detail
-
parent
protected final UiWebsocketImpl parent
-
-
Constructor Detail
-
WebsocketServer
public WebsocketServer(UiWebsocketImpl parent, java.lang.String name, int port, int poolSize, AbstractWebsocketServer.DebugMode debugMode)
-
-
Method Detail
-
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 classAbstractWebsocket<WsData>
- Returns:
- the typed
WsData
-
getOnOpen
protected OnOpen getOnOpen()
Description copied from class:AbstractWebsocket
Callback for websocket OnOpen event.- Specified by:
getOnOpen
in classAbstractWebsocket<WsData>
- Returns:
- the
OnOpen
callback
-
getOnRequest
protected OnRequest getOnRequest()
Description copied from class:AbstractWebsocket
Callback for JSON-RPC request.- Specified by:
getOnRequest
in classAbstractWebsocket<WsData>
- Returns:
- the
OnRequest
callback
-
getOnNotification
public OnNotification getOnNotification()
Description copied from class:AbstractWebsocket
Callback for JSON-RPC notification.- Specified by:
getOnNotification
in classAbstractWebsocket<WsData>
- Returns:
- the
OnNotification
callback
-
getOnError
protected OnError getOnError()
Description copied from class:AbstractWebsocket
Callback for websocket error.- Specified by:
getOnError
in classAbstractWebsocket<WsData>
- Returns:
- the
OnError
callback
-
getOnClose
protected OnClose getOnClose()
Description copied from class:AbstractWebsocket
Callback for websocket OnClose event.- Specified by:
getOnClose
in classAbstractWebsocket<WsData>
- Returns:
- the
OnClose
callback
-
handleNonJsonrpcMessage
protected JsonrpcMessage handleNonJsonrpcMessage(org.java_websocket.WebSocket ws, java.lang.String stringMessage, OpenemsError.OpenemsNamedException lastException) throws OpenemsError.OpenemsNamedException
Description copied from class:AbstractWebsocketServer
Handle Non-JSON-RPC messages.- Overrides:
handleNonJsonrpcMessage
in classAbstractWebsocketServer<WsData>
- Parameters:
ws
- theWebSocket
stringMessage
- the messagelastException
- 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, java.lang.String message)
Description copied from class:AbstractWebsocket
Log a info message.- Specified by:
logInfo
in classAbstractWebsocket<WsData>
- Parameters:
log
- a Logger instancemessage
- the message
-
logWarn
protected void logWarn(org.slf4j.Logger log, java.lang.String message)
Description copied from class:AbstractWebsocket
Log a warn message.- Specified by:
logWarn
in classAbstractWebsocket<WsData>
- Parameters:
log
- a Logger instancemessage
- the message
-
logError
protected void logError(org.slf4j.Logger log, java.lang.String message)
Description copied from class:AbstractWebsocket
Log a error message.- Specified by:
logError
in classAbstractWebsocket<WsData>
- Parameters:
log
- a Logger instancemessage
- the message
-
-