Skip to content

Commit

Permalink
Add instructions on producing an Event Identify Global message. (#533)
Browse files Browse the repository at this point in the history
  • Loading branch information
bakerstu authored Apr 7, 2021
1 parent 237d9e9 commit 9731cec
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/openlcb/BroadcastTimeServer.hxx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 9731cec

Please sign in to comment.