From 9731cec6858ea278fd3c0955b96d5926627aa80e Mon Sep 17 00:00:00 2001 From: Stuart W Baker Date: Wed, 7 Apr 2021 10:54:20 -0500 Subject: [PATCH] Add instructions on producing an Event Identify Global message. (#533) --- src/openlcb/BroadcastTimeServer.hxx | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/openlcb/BroadcastTimeServer.hxx b/src/openlcb/BroadcastTimeServer.hxx index fc7c96343..0a208116d 100644 --- a/src/openlcb/BroadcastTimeServer.hxx +++ b/src/openlcb/BroadcastTimeServer.hxx @@ -46,7 +46,15 @@ class BroadcastTimeServerSync; class BroadcastTimeServerSet; class BroadcastTimeServerAlarm; -/// Implementation of a Broadcast Time Protocol client. +/// Implementation of a Broadcast Time Protocol server. Note: A Broadcast Time +/// server must produce all the individual time events for which there is an +/// identified consumer. In order to guarantee that the server can identify all +/// of the consumers, it is important to have an Event Identify Global message +/// sent after the creation of the server object. In order to prevent +/// unnecessary duplication of Event Identify Global messages, it is left to +/// the application to send the Event Identify Global message. An application +/// can use the @ref openlcb::EventIdentifyGlobal object for production of an +/// Event Identify Global message. class BroadcastTimeServer : public BroadcastTime { public: