Package io.openems.common.websocket

Class DummyWebsocketServer

java.lang.Object

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

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

io.openems.common.websocket.DummyWebsocketServer

All Implemented Interfaces:

java.lang.AutoCloseable

public class DummyWebsocketServer
extends AbstractWebsocketServer<WsData>
implements java.lang.AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DummyWebsocketServer.Builder

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

AbstractWebsocketServer.DebugMode

Method Summary

Modifier and Type	Method	Description
void	close()
static DummyWebsocketServer.Builder	create()	Create a Config builder.
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.
protected OnNotification	getOnNotification()	Callback for JSON-RPC notification.
protected OnOpen	getOnOpen()	Callback for websocket OnOpen event.
protected OnRequest	getOnRequest()	Callback for JSON-RPC request.
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, handleNonJsonrpcMessage, 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

Method Detail

create

public static DummyWebsocketServer.Builder create()

Create a Config builder.

Returns:

a DummyWebsocketServer.Builder

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

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

protected 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

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

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

Parameters:

log - a Logger instance

message - the message

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception