Package com.vaadin.base.devserver
Class DebugWindowConnection
java.lang.Object
com.vaadin.base.devserver.DebugWindowConnection
- All Implemented Interfaces:
BrowserLiveReload
BrowserLiveReload
implementation class.
For internal use only. May be renamed or removed in a future release.
- Author:
- Vaadin Ltd
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Implementation of the development tools interface.Nested classes/interfaces inherited from interface com.vaadin.flow.internal.BrowserLiveReload
BrowserLiveReload.Backend
-
Method Summary
Modifier and TypeMethodDescriptionDetects and return enabling live reload backend technology.protected DevToolsInterface
getDevToolsInterface
(org.atmosphere.cpr.AtmosphereResource resource) 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, notnull
.void
Called when any message is received through the connection.void
reload()
Requests reload via the resource provided viaBrowserLiveReload.onConnect(AtmosphereResource)
call.void
setBackend
(BrowserLiveReload.Backend backend) Sets the live reload backend technology explicitly.void
Request an update of the resource with the given path.
-
Method Details
-
getBackend
Description copied from interface:BrowserLiveReload
Detects and return enabling live reload backend technology.- Specified by:
getBackend
in interfaceBrowserLiveReload
- Returns:
- enabling technology, or
null
if none
-
setBackend
Description copied from interface:BrowserLiveReload
Sets the live reload backend technology explicitly.- Specified by:
setBackend
in interfaceBrowserLiveReload
- Parameters:
backend
- enabling technology, notnull
.
-
getDevToolsInterface
-
onConnect
public void onConnect(org.atmosphere.cpr.AtmosphereResource resource) Description copied from interface:BrowserLiveReload
Sets the web socket connection resource when it's established.- Specified by:
onConnect
in interfaceBrowserLiveReload
- Parameters:
resource
- a web socket connection resource, notnull
.
-
onDisconnect
public void onDisconnect(org.atmosphere.cpr.AtmosphereResource resource) Description copied from interface:BrowserLiveReload
Removes the web socket connection resource, notnull
.- Specified by:
onDisconnect
in interfaceBrowserLiveReload
- Parameters:
resource
- a web socket connection resource
-
isLiveReload
public boolean isLiveReload(org.atmosphere.cpr.AtmosphereResource resource) Description copied from interface:BrowserLiveReload
Returns whether the passed connection is a browser live-reload connection.- Specified by:
isLiveReload
in interfaceBrowserLiveReload
- Parameters:
resource
- a web socket connection resource, notnull
.- Returns:
- whether the web socket connection is for live reload
-
reload
public void reload()Description copied from interface:BrowserLiveReload
Requests reload via the resource provided viaBrowserLiveReload.onConnect(AtmosphereResource)
call.- Specified by:
reload
in interfaceBrowserLiveReload
-
update
Description copied from interface:BrowserLiveReload
Request an update of the resource with the given path.- Specified by:
update
in interfaceBrowserLiveReload
- Parameters:
path
- the path of the file to update, relative to the servlet pathcontent
- the new content of the file
-
onMessage
Description copied from interface:BrowserLiveReload
Called when any message is received through the connection.- Specified by:
onMessage
in interfaceBrowserLiveReload
- Parameters:
resource
- the atmosphere resource that received the messagemessage
- the received message
-