com.smartdevicelink.protocol.heartbeat

Class HeartbeatMonitor

java.lang.Object

com.smartdevicelink.protocol.heartbeat.HeartbeatMonitor

All Implemented Interfaces:

IHeartbeatMonitor

public class HeartbeatMonitor
extends Object
implements IHeartbeatMonitor

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEARTBEAT_INTERVAL
static int	HEARTBEAT_INTERVAL_MAX

Constructor Summary

Constructors

Constructor and Description
HeartbeatMonitor()

Method Summary

Modifier and Type	Method and Description
Runnable	getHeartbeatRunnable()
int	getInterval() Returns the heartbeat messages interval.
IHeartbeatMonitorListener	getListener() Returns the listener.
void	heartbeatACKReceived() Notifies the monitor about a received heartbeat ACK message.
void	heartbeatReceived() Notifies the monitor about a received heartbeat message.
boolean	isHeartbeatReceived()
void	notifyTransportActivity() Notifies the monitor about sent/received messages.
void	setInterval(int value) Sets the interval for sending heartbeat messages if nothing is sent over transport.
void	setListener(IHeartbeatMonitorListener value) Sets the heartbeat's listener.
void	start() Starts the monitor.
void	stop() Stops the monitor.

Methods inherited from class java.lang.Object

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

Field Detail

HEARTBEAT_INTERVAL

public static final int HEARTBEAT_INTERVAL

See Also:

Constant Field Values

HEARTBEAT_INTERVAL_MAX

public static final int HEARTBEAT_INTERVAL_MAX

See Also:

Constant Field Values

Constructor Detail

HeartbeatMonitor

public HeartbeatMonitor()

Method Detail

getHeartbeatRunnable

public Runnable getHeartbeatRunnable()

isHeartbeatReceived

public boolean isHeartbeatReceived()

start

public void start()

Description copied from interface: IHeartbeatMonitor

Starts the monitor. If the monitor is already started, nothing happens.

Specified by:

start in interface IHeartbeatMonitor

stop

public void stop()

Description copied from interface: IHeartbeatMonitor

Stops the monitor. Does nothing if it is already stopped.

Specified by:

stop in interface IHeartbeatMonitor

getInterval

public int getInterval()

Description copied from interface: IHeartbeatMonitor

Returns the heartbeat messages interval.

Specified by:

getInterval in interface IHeartbeatMonitor

Returns:

interval in milliseconds

setInterval

public void setInterval(int value)

Description copied from interface: IHeartbeatMonitor

Sets the interval for sending heartbeat messages if nothing is sent over transport.

Specified by:

setInterval in interface IHeartbeatMonitor

Parameters:

value - interval in milliseconds (min/max values depend on concrete implementations)

getListener

public IHeartbeatMonitorListener getListener()

Description copied from interface: IHeartbeatMonitor

Returns the listener.

Specified by:

getListener in interface IHeartbeatMonitor

Returns:

the listener

setListener

public void setListener(IHeartbeatMonitorListener value)

Description copied from interface: IHeartbeatMonitor

Sets the heartbeat's listener.

Specified by:

setListener in interface IHeartbeatMonitor

Parameters:

value - the new listener

notifyTransportActivity

public void notifyTransportActivity()

Description copied from interface: IHeartbeatMonitor

Notifies the monitor about sent/received messages.

Specified by:

notifyTransportActivity in interface IHeartbeatMonitor

heartbeatACKReceived

public void heartbeatACKReceived()

Description copied from interface: IHeartbeatMonitor

Notifies the monitor about a received heartbeat ACK message.

Specified by:

heartbeatACKReceived in interface IHeartbeatMonitor

heartbeatReceived

public void heartbeatReceived()

Description copied from interface: IHeartbeatMonitor

Notifies the monitor about a received heartbeat message.

Specified by:

heartbeatReceived in interface IHeartbeatMonitor