Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add instructions on producing an Event Identify Global message #533

Merged
merged 1 commit into from
Apr 7, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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