com.prosysopc.ua.pubsub

Interface PubSubStatusMessage

All Known Implementing Classes:

PubSubJsonStatusMessage, PubSubUadpStatusMessage

public interface PubSubStatusMessage

Interface grouping common values in all PubSub StatusMessages.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PubSubStatusMessage.Builder<T extends PubSubStatusMessage.Builder<T>> Builder for the common part.

Method Summary

Modifier and Type	Method and Description
boolean	getIsCyclic() True if Publisher periodically publishes status (see getNextReportTime()).
DateTime	getNextReportTime() Returns when the next status update is expected.
PubSubState	getStatus() Status of the Publisher.

Method Detail

getIsCyclic

boolean getIsCyclic()

True if Publisher periodically publishes status (see getNextReportTime()). If false, the middleware (such as a MQTT Broker) should notify errors (via such as MQTT Will message).

getNextReportTime

DateTime getNextReportTime()

Returns when the next status update is expected. NOTE, this can be null and should be ignored if getIsCyclic() is false.

getStatus

PubSubState getStatus()

Status of the Publisher.