Package org.openhab.core.io.websocket.event

Class EventWebSocket

java.lang.Object

org.openhab.core.io.websocket.event.EventWebSocket

All Implemented Interfaces:

org.eclipse.jetty.websocket.api.WriteCallback

@WebSocket
@NonNullByDefault
public class EventWebSocket
extends Object
implements org.eclipse.jetty.websocket.api.WriteCallback

The EventWebSocket is the WebSocket implementation that extends the event bus

Author:

Jan N. Klug - Initial contribution, Florian Hotze - Add topic filter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WEBSOCKET_EVENT_TYPE
static final String	WEBSOCKET_TOPIC_PREFIX

Constructor Summary

Constructors

Constructor	Description
EventWebSocket(com.google.gson.Gson gson, EventWebSocketAdapter wsAdapter, ItemEventUtility itemEventUtility, EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
void	onClose(int statusCode, String reason)
void	onConnect(org.eclipse.jetty.websocket.api.Session session)
void	onError(@Nullable org.eclipse.jetty.websocket.api.Session session, @Nullable Throwable error)
void	onText(String message)
void	processEvent(Event event)
void	writeFailed(@Nullable Throwable x)
void	writeSuccess()

Methods inherited from class java.lang.Object

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

Field Details

WEBSOCKET_EVENT_TYPE

public static final String WEBSOCKET_EVENT_TYPE

See Also:

• Constant Field Values

WEBSOCKET_TOPIC_PREFIX

public static final String WEBSOCKET_TOPIC_PREFIX

See Also:

• Constant Field Values

Constructor Details

EventWebSocket

public EventWebSocket(com.google.gson.Gson gson,
 EventWebSocketAdapter wsAdapter,
 ItemEventUtility itemEventUtility,
 EventPublisher eventPublisher)

Method Details

onClose

@OnWebSocketClose
public void onClose(int statusCode,
 String reason)

onConnect

@OnWebSocketConnect
public void onConnect(org.eclipse.jetty.websocket.api.Session session)

onText

@OnWebSocketMessage
public void onText(String message)

onError

@OnWebSocketError
public void onError(@Nullable org.eclipse.jetty.websocket.api.Session session,
 @Nullable Throwable error)

processEvent

public void processEvent(Event event)

writeFailed

public void writeFailed(@Nullable Throwable x)

Specified by:

writeFailed in interface org.eclipse.jetty.websocket.api.WriteCallback

writeSuccess

public void writeSuccess()

Specified by:

writeSuccess in interface org.eclipse.jetty.websocket.api.WriteCallback