Package org.openmuc.jeebus.spine.utils.features.devicediagnosis

Class HeartbeatDataFunction

java.lang.Object

org.openmuc.jeebus.spine.spi.function.FeatureFunction

org.openmuc.jeebus.spine.utils.features.devicediagnosis.HeartbeatDataFunction

All Implemented Interfaces:

java.lang.AutoCloseable, Shutdownable

public class HeartbeatDataFunction
extends FeatureFunction

Field Summary

Fields inherited from class org.openmuc.jeebus.spine.spi.function.FeatureFunction

feature

Method Summary

Modifier and Type	Method	Description
SpineAcknowledgment	call(org.openmuc.jeebus.spine.xsd.v1.CmdType cmd, org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType sourceAddress)
void	close()	Cleanly and promptly shut down this object, as well as all child objects and objects depending on this one.
void	increaseCounterAndNotifySubscribers()
org.openmuc.jeebus.spine.xsd.v1.CmdType	read(org.openmuc.jeebus.spine.xsd.v1.FilterType filter, org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType featureAddress)
void	shutdownExecutor()
java.util.concurrent.ScheduledFuture<?>	startHeartbeat()
SpineAcknowledgment	write(org.openmuc.jeebus.spine.xsd.v1.CmdType cmdType, org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType featureAddressType)

Methods inherited from class org.openmuc.jeebus.spine.spi.function.FeatureFunction

bindingRequired, getFunctionName, getFunctionProperty, isCallable, isReadable, isWritable, matchAddress, requireBinding, setCallable, setFeature, setReadable, setWritable

Methods inherited from class java.lang.Object

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

Method Detail

read

public org.openmuc.jeebus.spine.xsd.v1.CmdType read(org.openmuc.jeebus.spine.xsd.v1.FilterType filter,
                                                    org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType featureAddress)

Specified by:

read in class FeatureFunction

Parameters:

filter - filter for partial read otherwise null

featureAddress - the feature address of the client feature

Returns:

an CmdType instance filled with the requested information

write

public SpineAcknowledgment write(org.openmuc.jeebus.spine.xsd.v1.CmdType cmdType,
                                 org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType featureAddressType)

Specified by:

write in class FeatureFunction

Parameters:

cmdType - to be written data including optional filters for restricted function exchange

featureAddressType - the feature address of the client feature

Returns:

an acknowledgment stating the result of the operation

call

public SpineAcknowledgment call(org.openmuc.jeebus.spine.xsd.v1.CmdType cmd,
                                org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType sourceAddress)

Specified by:

call in class FeatureFunction

Parameters:

cmd - the command data belonging to this function call

sourceAddress - the feature address of the client feature

Returns:

an acknowledgment stating the result of the operation

startHeartbeat

public java.util.concurrent.ScheduledFuture<?> startHeartbeat()

increaseCounterAndNotifySubscribers

public void increaseCounterAndNotifySubscribers()

shutdownExecutor

public void shutdownExecutor()

close

public void close()

Description copied from interface: Shutdownable

Cleanly and promptly shut down this object, as well as all child objects and objects depending on this one.