com.github.mcollovati.vertx.vaadin.sockjs.communication.VertxVaadinLiveReload Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-vaadin-flow Show documentation

An adapter to run Vaadin Flow applications on Vertx

The newest version!

/*
 * The MIT License
 * Copyright © 2016-2020 Marco Collovati ([email protected])
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.github.mcollovati.vertx.vaadin.sockjs.communication;

import elemental.json.JsonObject;

/**
 * Provides a way to reload browser tabs via web socket connection.
 */
public interface VertxVaadinLiveReload {

    /**
     * Requests reload
     */
    void reload();

    /**
     * Request an update of the resource with the given path.
     *
     * @param path
     *            the path of the file to update, relative to the servlet path
     * @param content
     *            the new content of the file
     */
    void update(String path, String content);

    /**
     * Send a client side HMR event.
     *
     * @param event
     *            the event name
     * @param eventData
     *            the event data
     */
    void sendHmrEvent(String event, JsonObject eventData);

}