org.lsst.ccs.bus.messages

Class StatusHeartBeat

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage<T,D>

org.lsst.ccs.bus.messages.StatusMessage

org.lsst.ccs.bus.messages.StatusHeartBeat

All Implemented Interfaces:

Serializable

public final class StatusHeartBeat
extends StatusMessage

Heartbeat status message. It is published at regular intervals: it is the pulse of an Agent. Not all agents publish a Heartbeat. This message is meant to be very light weight. It does not provide any encoding. All it contains is the broadcast interval in seconds so that agents listening to the heartbeat can estimate when the next one is expected to be published.

Author:

The LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StatusHeartBeat(int statusBroadcastPeriod, StateBundle state)

Method Summary

Modifier and Type	Method and Description
protected KeyValueDataList	encodeObject(Serializable obj) Subclasses must provide a specific implementation of the encoding process.
int	getStatusBroadcastPeriod() Get the broadcast period in milliseconds.

Methods inherited from class org.lsst.ccs.bus.messages.StatusMessage

getState, toString

Methods inherited from class org.lsst.ccs.bus.messages.BusMessage

getCCSTimeStamp, getClassName, getEncodedData, getObject, getOriginAgentInfo, getTimeStamp, setOriginAgentInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusHeartBeat

public StatusHeartBeat(int statusBroadcastPeriod,
                       StateBundle state)

Method Detail

getStatusBroadcastPeriod

public int getStatusBroadcastPeriod()

Get the broadcast period in milliseconds. This value is used by listening agents to estimate when to next expect the next heartbeat.

Returns:

The broadcasting period in milliseconds.

encodeObject

protected KeyValueDataList encodeObject(Serializable obj)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.