microsoft.aspnet.signalr.client

Class HeartbeatMonitor

java.lang.Object

microsoft.aspnet.signalr.client.HeartbeatMonitor

public class HeartbeatMonitor
extends Object

Heartbeat Monitor to detect slow or timed out connections

Constructor Summary

Constructors

Constructor and Description
HeartbeatMonitor()

Method Summary

Modifier and Type	Method and Description
void	beat() Alerts the monitor that a beat was detected
microsoft.aspnet.signalr.client.KeepAliveData	getKeepAliveData() Returns the Keep Alive data
Runnable	getOnTimeout() Returns the "Timeout" event handler
Runnable	getOnWarning() Returns the "Warning" event handler
void	setKeepAliveData(microsoft.aspnet.signalr.client.KeepAliveData keepAliveData) Sets the Keep Alive data
void	setOnTimeout(Runnable onTimeout) Sets the "Timeout" event handler
void	setOnWarning(Runnable onWarning) Sets the "Warning" event handler
void	start(microsoft.aspnet.signalr.client.KeepAliveData keepAliveData, ConnectionBase connection) Starts the monitor
void	stop() Stops the heartbeat monitor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeartbeatMonitor

public HeartbeatMonitor()

Method Detail

start

public void start(microsoft.aspnet.signalr.client.KeepAliveData keepAliveData,
                  ConnectionBase connection)

Starts the monitor

Parameters:

keepAliveData - Data for keep-alive timings

connection - Connection to monitor

stop

public void stop()

Stops the heartbeat monitor

beat

public void beat()

Alerts the monitor that a beat was detected

getOnWarning

public Runnable getOnWarning()

Returns the "Warning" event handler

Returns:

Runnable OnWarning

setOnWarning

public void setOnWarning(Runnable onWarning)

Sets the "Warning" event handler

Parameters:

onWarning - Runnable

getOnTimeout

public Runnable getOnTimeout()

Returns the "Timeout" event handler

Returns:

Runnable OnTimeout

setOnTimeout

public void setOnTimeout(Runnable onTimeout)

Sets the "Timeout" event handler

Parameters:

onTimeout - Runnable

getKeepAliveData

public microsoft.aspnet.signalr.client.KeepAliveData getKeepAliveData()

Returns the Keep Alive data

Returns:

KeepAliveData KeepAliveData

setKeepAliveData

public void setKeepAliveData(microsoft.aspnet.signalr.client.KeepAliveData keepAliveData)

Sets the Keep Alive data

Parameters:

keepAliveData - KeepAliveData