io.openems.common.websocket

Class AbstractWebsocket<T extends WsData>

java.lang.Object

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

Direct Known Subclasses:

AbstractWebsocketClient, AbstractWebsocketServer

public abstract class AbstractWebsocket<T extends WsData>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractWebsocket(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected abstract T	createWsData() Creates an empty WsData object that is attached to the WebSocket as early as possible
java.lang.String	getName() Gets the internal name of this websocket client/server
protected abstract OnClose	getOnClose() Callback for websocket OnClose event
protected abstract OnError	getOnError() Callback for websocket error
protected abstract OnInternalError	getOnInternalError() Callback for internal error
protected abstract OnNotification	getOnNotification() Callback for JSON-RPC notification
protected abstract OnOpen	getOnOpen() Callback for websocket OnOpen event
protected abstract OnRequest	getOnRequest() Callback for JSON-RPC request
protected void	handleInternalErrorAsync(java.lang.Exception e) Handles an internal Error asynchronously
protected void	handleInternalErrorSync(java.lang.Exception e, java.lang.String wsDataString) Handles an internal Error synchronously
protected abstract void	logInfo(org.slf4j.Logger log, java.lang.String message) Log a info message.
protected abstract void	logWarn(org.slf4j.Logger log, java.lang.String message) Log a warn message.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWebsocket

public AbstractWebsocket(java.lang.String name)

Method Detail

createWsData

protected abstract T createWsData()

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

Returns:

getOnInternalError

protected abstract OnInternalError getOnInternalError()

Callback for internal error

Returns:

getOnOpen

protected abstract OnOpen getOnOpen()

Callback for websocket OnOpen event

Returns:

getOnRequest

protected abstract OnRequest getOnRequest()

Callback for JSON-RPC request

Returns:

getOnNotification

protected abstract OnNotification getOnNotification()

Callback for JSON-RPC notification

Returns:

getOnError

protected abstract OnError getOnError()

Callback for websocket error

Returns:

getOnClose

protected abstract OnClose getOnClose()

Callback for websocket OnClose event

Returns:

getName

public java.lang.String getName()

Gets the internal name of this websocket client/server

Returns:

handleInternalErrorAsync

protected void handleInternalErrorAsync(java.lang.Exception e)

Handles an internal Error asynchronously

Parameters:

e -

handleInternalErrorSync

protected void handleInternalErrorSync(java.lang.Exception e,
                                       java.lang.String wsDataString)

Handles an internal Error synchronously

Parameters:

e -

logInfo

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

Log a info message.

Parameters:

log - a Logger instance

message - the message

logWarn

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

Log a warn message.

Parameters:

log - a Logger instance

message - the message