Package com.vaadin.flow.internal

Interface BrowserLiveReload

  • All Known Implementing Classes:
    DebugWindowConnection
    public interface BrowserLiveReload
    Provides a way to reload browser tabs via web socket connection passed as a AtmosphereResource.

    For internal use only. May be renamed or removed in a future release.

    Author:
    Vaadin Ltd

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  BrowserLiveReload.Backend
      Live reload enabling technology detected.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      BrowserLiveReload.Backend getBackend()
      Detects and return enabling live reload backend technology.
      boolean isLiveReload​(org.atmosphere.cpr.AtmosphereResource resource)
      Returns whether the passed connection is a browser live-reload connection.
      void onConnect​(org.atmosphere.cpr.AtmosphereResource resource)
      Sets the web socket connection resource when it's established.
      void onDisconnect​(org.atmosphere.cpr.AtmosphereResource resource)
      Removes the web socket connection resource, not null.
      void onMessage​(org.atmosphere.cpr.AtmosphereResource resource, String msg)
      Called when any message is received through the connection.
      void reload()
      Requests reload via the resource provided via onConnect(AtmosphereResource) call.
      void setBackend​(BrowserLiveReload.Backend backend)
      Sets the live reload backend technology explicitly.

    • Method Detail

      • getBackend

        BrowserLiveReload.Backend getBackend()
        Detects and return enabling live reload backend technology.
        Returns:
        enabling technology, or null if none

      • setBackend

        void setBackend​(BrowserLiveReload.Backend backend)
        Sets the live reload backend technology explicitly.
        Parameters:
        backend - enabling technology, not null.

      • onConnect

        void onConnect​(org.atmosphere.cpr.AtmosphereResource resource)
        Sets the web socket connection resource when it's established.
        Parameters:
        resource - a web socket connection resource, not null.

      • onDisconnect

        void onDisconnect​(org.atmosphere.cpr.AtmosphereResource resource)
        Removes the web socket connection resource, not null.
        Parameters:
        resource - a web socket connection resource

      • isLiveReload

        boolean isLiveReload​(org.atmosphere.cpr.AtmosphereResource resource)
        Returns whether the passed connection is a browser live-reload connection.
        Parameters:
        resource - a web socket connection resource, not null.
        Returns:
        whether the web socket connection is for live reload

      • onMessage

        void onMessage​(org.atmosphere.cpr.AtmosphereResource resource,
               String msg)
        Called when any message is received through the connection.
        Parameters:
        resource - the atmosphere resource that received the message
        msg - the received message