io.openems.backend.uiwebsocket.impl

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>

Constructor Summary

Constructors

Constructor and Description
WebsocketServer(UiWebsocketImpl parent, java.lang.String name, int port)

Method Summary

Modifier and Type	Method and 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(java.lang.String stringMessage, OpenemsError.OpenemsNamedException lastException) Convert deprecated Non-JSON-RPC messages to JSON-RPC messages.
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, getConnections, getOnInternalError, 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 Detail

WebsocketServer

public WebsocketServer(UiWebsocketImpl parent,
                       java.lang.String name,
                       int port)

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 class AbstractWebsocket<WsData>

Returns:

getOnOpen

protected OnOpen getOnOpen()

Description copied from class: AbstractWebsocket

Callback for websocket OnOpen event

Specified by:

getOnOpen in class AbstractWebsocket<WsData>

Returns:

getOnRequest

protected OnRequest getOnRequest()

Description copied from class: AbstractWebsocket

Callback for JSON-RPC request

Specified by:

getOnRequest in class AbstractWebsocket<WsData>

Returns:

getOnNotification

public OnNotification getOnNotification()

Description copied from class: AbstractWebsocket

Callback for JSON-RPC notification

Specified by:

getOnNotification in class AbstractWebsocket<WsData>

Returns:

getOnError

protected OnError getOnError()

Description copied from class: AbstractWebsocket

Callback for websocket error

Specified by:

getOnError in class AbstractWebsocket<WsData>

Returns:

getOnClose

protected OnClose getOnClose()

Description copied from class: AbstractWebsocket

Callback for websocket OnClose event

Specified by:

getOnClose in class AbstractWebsocket<WsData>

Returns:

handleNonJsonrpcMessage

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

Description copied from class: AbstractWebsocketServer

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

Overrides:

handleNonJsonrpcMessage in class AbstractWebsocketServer<WsData>

Returns:

Throws:

OpenemsError.OpenemsNamedException

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 class AbstractWebsocket<WsData>

Parameters:

log - a Logger instance

message - 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 class AbstractWebsocket<WsData>

Parameters:

log - a Logger instance

message - the message