xyz.jetdrone.vertx.hot.reload

Interface HotReload

All Superinterfaces:

io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>

All Known Implementing Classes:

HotReloadImpl

public interface HotReload
extends io.vertx.core.Handler<io.vertx.ext.web.RoutingContext>

A Simple Hot Reload for Eclipse Vert.x Web.

Usage: In your main HTML file add the following script at the end of the body. <script src="/hot-reload/script" type="application/javascript"></script> Once the server stops or reload the handler the script will force a page reload. During the down time of the server the script will attempt to reconnect every second.

Author:

Paulo Lopes

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.core.logging.Logger	LOGGER

Method Summary

Modifier and Type	Method and Description
static HotReload	create() If the system property hot.reload is true then it creates a HotReload Handler that will setup 2 endpoints:
static HotReload	create(boolean sse) Creates a HotReload Handler that will setup 2 endpoints.
static io.vertx.ext.web.handler.StaticHandler	createStaticHandler() Creates a StaticHandler that will be configured to be non cached and point to the path src/main/resouces + webroot

Methods inherited from interface io.vertx.core.Handler

handle

Field Detail

LOGGER

static final io.vertx.core.logging.Logger LOGGER

Method Detail

create

static HotReload create()

If the system property hot.reload is true then it creates a HotReload Handler that will setup 2 endpoints:

1. /hot-reload

   the watch endpoint either a SSE or AJAX endpoint that returns the current deployment id

2. /hot-reload/script

   the script to be added to the main HTML

By default it will use the SSE mode. Else this is a noop handler (pass through).

Returns:

HotReload Handler

create

static HotReload create(boolean sse)

Creates a HotReload Handler that will setup 2 endpoints.

Parameters:

sse - if true then SSE will be used, otherwise AJAX.

Returns:

HotReload Handler

See Also:

create()

createStaticHandler

static io.vertx.ext.web.handler.StaticHandler createStaticHandler()

Creates a StaticHandler that will be configured to be non cached and point to the path src/main/resouces + webroot

Returns:

StaticHandler