io.openems.edge.controller.api.backend

Class WebsocketClient

java.lang.Object

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

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

io.openems.edge.controller.api.backend.WebsocketClient

public class WebsocketClient
extends AbstractWebsocketClient<WsData>

Field Summary

Fields inherited from class io.openems.common.websocket.AbstractWebsocketClient

DEFAULT_DRAFT, NO_HTTP_HEADERS, NO_PROXY, ws

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebsocketClient(BackendApiImpl parent, java.lang.String name, java.net.URI serverUri, java.util.Map<java.lang.String,java.lang.String> httpHeaders, java.net.Proxy proxy)

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
OnClose	getOnClose() Callback for websocket OnClose event
OnError	getOnError() Callback for websocket error
OnNotification	getOnNotification() Callback for JSON-RPC notification
OnOpen	getOnOpen() Callback for websocket OnOpen event
OnRequest	getOnRequest() Callback for JSON-RPC request
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.AbstractWebsocketClient

getOnInternalError, sendMessage, sendMessageOrError, sendRequest, start, startBlocking, 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

WebsocketClient

protected WebsocketClient(BackendApiImpl parent,
                          java.lang.String name,
                          java.net.URI serverUri,
                          java.util.Map<java.lang.String,java.lang.String> httpHeaders,
                          java.net.Proxy proxy)

Method Detail

getOnOpen

public OnOpen getOnOpen()

Description copied from class: AbstractWebsocket

Callback for websocket OnOpen event

Specified by:

getOnOpen in class AbstractWebsocket<WsData>

Returns:

getOnRequest

public 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

public OnError getOnError()

Description copied from class: AbstractWebsocket

Callback for websocket error

Specified by:

getOnError in class AbstractWebsocket<WsData>

Returns:

getOnClose

public OnClose getOnClose()

Description copied from class: AbstractWebsocket

Callback for websocket OnClose event

Specified by:

getOnClose in class AbstractWebsocket<WsData>

Returns:

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:

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