com.smartdevicelink.protocol.heartbeat

Interface IHeartbeatMonitor

All Known Implementing Classes:

HeartbeatMonitor

public interface IHeartbeatMonitor

Method Summary

Modifier and Type	Method and Description
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.
void	notifyTransportActivity() Notifies the monitor about sent/received messages.
void	setInterval(int interval) Sets the interval for sending heartbeat messages if nothing is sent over transport.
void	setListener(IHeartbeatMonitorListener listener) Sets the heartbeat's listener.
void	start() Starts the monitor.
void	stop() Stops the monitor.

Method Detail

start

void start()

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

stop

void stop()

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

getInterval

int getInterval()

Returns the heartbeat messages interval.

Returns:

interval in milliseconds

setInterval

void setInterval(int interval)

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

Parameters:

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

getListener

IHeartbeatMonitorListener getListener()

Returns the listener.

Returns:

the listener

setListener

void setListener(IHeartbeatMonitorListener listener)

Sets the heartbeat's listener.

Parameters:

listener - the new listener

notifyTransportActivity

void notifyTransportActivity()

Notifies the monitor about sent/received messages.

heartbeatACKReceived

void heartbeatACKReceived()

Notifies the monitor about a received heartbeat ACK message.

heartbeatReceived

void heartbeatReceived()

Notifies the monitor about a received heartbeat message.