com.vaadin.client.communication.

Class Heartbeat

  • public class Heartbeat
    extends Object

    Handles sending of heartbeats to the server and reacting to the response.

    Since:

    7.2

    Author:

    Vaadin Ltd

    • Constructor Detail

      • Heartbeat

        public Heartbeat()
    • Method Detail

      • init

        public void init​(ApplicationConnection applicationConnection)

        Initializes the heartbeat for the given application connection.

        Parameters:

        applicationConnection - the connection

      • send

        public void send()

        Sends a heartbeat to the server.

      • getInterval

        public int getInterval()

        Returns:

        the interval at which heartbeat requests are sent

      • schedule

        public void schedule()

        Updates the schedule of the heartbeat to match the set interval. A negative interval disables the heartbeat.

      • setInterval

        public void setInterval​(int heartbeatInterval)

        Changes the heartbeatInterval in runtime and applies it.

        Parameters:

        heartbeatInterval - new interval in seconds.