Package org.openhab.core.io.websocket.log

Class LogWebSocket

java.lang.Object
org.openhab.core.io.websocket.log.LogWebSocket
All Implemented Interfaces:
EventListener, org.osgi.service.log.LogListener
@WebSocket @NonNullByDefault public class LogWebSocket extends Object implements org.osgi.service.log.LogListener
The LogWebSocket is the WebSocket implementation for logs. This supports sending of history, and provides a method of managing message cadence. When a client connects, it must send a filter request before the server will send any logs. This triggers the sending of history. Live logs are sent as individual messages if they are received with sufficient spacing. When logs come in very quickly, they are clustered together and sent as an array after up to 100mS.
Author:
Jan N. Klug - Initial contribution, Chris Jackson - Add history and improve performance using arrays

  • Constructor Details

    • LogWebSocket

      public LogWebSocket(com.google.gson.Gson gson, LogWebSocketAdapter wsAdapter)

  • 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(org.eclipse.jetty.websocket.api.Session session, @Nullable Throwable error)

    • logged

      public void logged(@NonNullByDefault({}) org.osgi.service.log.LogEntry logEntry)
      Specified by:
      logged in interface org.osgi.service.log.LogListener