Package com.vaadin.client.communication
Class Heartbeat
- java.lang.Object
-
- com.vaadin.client.communication.Heartbeat
-
public class Heartbeat extends Object
Handles sending of heartbeats to the server and reacting to the response- Since:
- 1.0
- Author:
- Vaadin Ltd
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetInterval()voidschedule()Updates the schedule of the heartbeat to match the set interval.voidsend()Sends a heartbeat to the server.voidsetInterval(int heartbeatInterval)Changes the heartbeatInterval in runtime and applies it.
-
-
-
Constructor Detail
-
Heartbeat
public Heartbeat(Registry registry)
Creates a new instance connected to the given registry.- Parameters:
registry- the global registry
-
-
Method Detail
-
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 final void setInterval(int heartbeatInterval)
Changes the heartbeatInterval in runtime and applies it.- Parameters:
heartbeatInterval- new interval in seconds.
-
-