Skip to content

Allow extensibility of BCP-008 status monitors #511

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.

Sign up for GitHub

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

Merged
lo-simon merged 9 commits into from
Aug 5, 2026
Merged

Allow extensibility of BCP-008 status monitors #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
328a941
Refactor BCP-008 implmentation to streamline the control protocol's h…
jonathan-r-thorpe Jul 27, 2026
37e0348
Enhance receiver monitor domains by adding detailed comments and rest…
jonathan-r-thorpe Jul 27, 2026
f626766
Add is_receiver_monitor function to control_protocol_utils
jonathan-r-thorpe Jul 27, 2026
c04c2f5
Merge remote-tracking branch 'origin/master' into refactor-status-mon…
jonathan-r-thorpe Jul 29, 2026
741ecac
Rename insert method to insert_monitor_domains for clarity in control…
jonathan-r-thorpe Aug 4, 2026
6a95ba5
Remove internal status monitor funcitons from API
jonathan-r-thorpe Aug 4, 2026
7de25df
Add comment to node_implementation_init for custom status monitor exa…
jonathan-r-thorpe Aug 4, 2026
0889399
Merge branch 'sony:master' into refactor-status-monitors
jonathan-r-thorpe Aug 4, 2026
ca83dda
Move get_monitor_domains_handler to control protocol handlers
jonathan-r-thorpe Aug 5, 2026
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
2 changes: 2 additions & 0 deletions Development/nmos-cpp-node/node_implementation.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1597,6 +1597,8 @@ void node_implementation_init(nmos::node_model& model, nmos::experimental::contr
nmos::set_block_allowed_member_classes(receiver_monitors_block, {nmos::nc_receiver_monitor_class_id});

// example receiver-monitor(s)
// For an example of defining a custom status monitor (derived class + monitor domains), see
// testSetDerivedMonitorDomainStatus in nmos/test/control_protocol_utils_test.cpp
{
int count = 0;
for (int index = 0; index < how_many; ++index)
Expand Down
52 changes: 19 additions & 33 deletions Development/nmos/control_protocol_behaviour.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,51 +8,36 @@

namespace nmos
{
namespace experimental
namespace nc
{
struct domain_status_properties
namespace details
{
domain_status_properties(const nc_property_id& status_property_id, const nc_property_id& status_message_property_id, const nc_property_id& status_transition_counter_property_id, const utility::string_t& status_pending_field_name, const utility::string_t& status_message_pending_field_name, const utility::string_t& status_pending_received_time_field_name)
: status_property_id(status_property_id)
, status_message_property_id(status_message_property_id)
, status_transition_counter_property_id(status_transition_counter_property_id)
, status_pending_field_name(status_pending_field_name)
, status_message_pending_field_name(status_message_pending_field_name)
, status_pending_received_time_field_name(status_pending_received_time_field_name)
{}

nc_property_id status_property_id;
nc_property_id status_message_property_id;
nc_property_id status_transition_counter_property_id;
utility::string_t status_pending_field_name;
utility::string_t status_message_pending_field_name;
utility::string_t status_pending_received_time_field_name;
};
// Declared here rather than in the public header; used only by the behaviour thread
bool set_monitor_status_internal(resources& resources, nc_oid oid, int status, const utility::string_t& status_message, const nc_property_id& status_property_id,
const nc_property_id& status_message_property_id,
const nc_property_id& status_transition_counter_property_id,
const utility::string_t& status_pending_received_time_field_name,
get_control_protocol_class_descriptor_handler get_control_protocol_class_descriptor,
get_monitor_domains_handler get_monitor_domains,
slog::base_gate& gate);
}
}

namespace experimental
{
void control_protocol_behaviour_thread(nmos::node_model& model, control_protocol_state& state, slog::base_gate& gate_)
{
nmos::details::omanip_gate gate(gate_, nmos::stash_category(nmos::categories::control_protocol_behaviour));

slog::log<slog::severities::info>(gate, SLOG_FLF) << "Starting control protocol behaviour thread";

std::vector<domain_status_properties> receiver_monitor_domain_statuses;
receiver_monitor_domain_statuses.push_back(domain_status_properties(nc_receiver_monitor_stream_status_property_id, nc_receiver_monitor_stream_status_message_property_id, nc_receiver_monitor_stream_status_transition_counter_property_id, nmos::fields::nc::stream_status_pending, nmos::fields::nc::stream_status_message_pending, nmos::fields::nc::stream_status_pending_received_time));
receiver_monitor_domain_statuses.push_back(domain_status_properties(nc_receiver_monitor_connection_status_property_id, nc_receiver_monitor_connection_status_message_property_id, nc_receiver_monitor_connection_status_transition_counter_property_id, nmos::fields::nc::connection_status_pending, nmos::fields::nc::connection_status_message_pending, nmos::fields::nc::connection_status_pending_received_time));
receiver_monitor_domain_statuses.push_back(domain_status_properties(nc_receiver_monitor_link_status_property_id, nc_receiver_monitor_link_status_message_property_id, nc_receiver_monitor_link_status_transition_counter_property_id, nmos::fields::nc::link_status_pending, nmos::fields::nc::link_status_message_pending, nmos::fields::nc::link_status_pending_received_time));
receiver_monitor_domain_statuses.push_back(domain_status_properties(nc_receiver_monitor_external_synchronization_status_property_id, nc_receiver_monitor_external_synchronization_status_message_property_id, nc_receiver_monitor_external_synchronization_status_transition_counter_property_id, nmos::fields::nc::external_synchronization_status_pending, nmos::fields::nc::external_synchronization_status_message_pending, nmos::fields::nc::external_synchronization_status_pending_received_time));

std::vector<domain_status_properties> sender_monitor_domain_statuses;
sender_monitor_domain_statuses.push_back(domain_status_properties(nc_sender_monitor_essence_status_property_id, nc_sender_monitor_essence_status_message_property_id, nc_sender_monitor_essence_status_transition_counter_property_id, nmos::fields::nc::essence_status_pending, nmos::fields::nc::essence_status_message_pending, nmos::fields::nc::essence_status_pending_received_time));
sender_monitor_domain_statuses.push_back(domain_status_properties(nc_sender_monitor_transmission_status_property_id, nc_sender_monitor_transmission_status_message_property_id, nc_sender_monitor_transmission_status_transition_counter_property_id, nmos::fields::nc::transmission_status_pending, nmos::fields::nc::transmission_status_message_pending, nmos::fields::nc::transmission_status_pending_received_time));
sender_monitor_domain_statuses.push_back(domain_status_properties(nc_sender_monitor_link_status_property_id, nc_sender_monitor_link_status_message_property_id, nc_sender_monitor_link_status_transition_counter_property_id, nmos::fields::nc::link_status_pending, nmos::fields::nc::link_status_message_pending, nmos::fields::nc::link_status_pending_received_time));
sender_monitor_domain_statuses.push_back(domain_status_properties(nc_sender_monitor_external_synchronization_status_property_id, nc_sender_monitor_external_synchronization_status_message_property_id, nc_sender_monitor_external_synchronization_status_transition_counter_property_id, nmos::fields::nc::external_synchronization_status_pending, nmos::fields::nc::external_synchronization_status_message_pending, nmos::fields::nc::external_synchronization_status_pending_received_time));

auto lock = model.write_lock();
auto& condition = model.condition;
auto& shutdown = model.shutdown;
auto& control_protocol_resources = model.control_protocol_resources;

auto get_control_protocol_class_descriptor = nmos::make_get_control_protocol_class_descriptor_handler(state);
auto get_monitor_domains = nmos::make_get_monitor_domains_handler(state);
// continue until the server is being shut down
for (;;)
{
Expand Down Expand Up @@ -91,7 +76,7 @@ namespace nmos

auto status_reporting_delay = nc::get_property(control_protocol_resources, oid, nc_status_monitor_status_reporting_delay, get_control_protocol_class_descriptor, gate);

const auto& domain_statuses = nmos::nc::is_sender_monitor(class_id) ? sender_monitor_domain_statuses : receiver_monitor_domain_statuses;
const auto domain_statuses = nmos::nc::get_monitor_domains(class_id, get_monitor_domains);

for (const auto& domain_status : domain_statuses)
{
Expand Down Expand Up @@ -128,7 +113,7 @@ namespace nmos

const auto status_reporting_delay = nc::get_property(control_protocol_resources, oid, nc_status_monitor_status_reporting_delay, get_control_protocol_class_descriptor, gate);

const auto& domain_statuses = nmos::nc::is_sender_monitor(class_id) ? sender_monitor_domain_statuses : receiver_monitor_domain_statuses;
const auto domain_statuses = nmos::nc::get_monitor_domains(class_id, get_monitor_domains);

for (const auto& domain_status : domain_statuses)
{
Expand All @@ -144,12 +129,13 @@ namespace nmos
const auto& status = nc::get_property(control_protocol_resources, oid, domain_status.status_pending_field_name, gate);
const auto& status_message = nc::get_property(control_protocol_resources, oid, domain_status.status_message_pending_field_name, gate);
const auto& status_message_string = status_message == web::json::value::null() ? U("") : status_message.as_string();
nc::details::set_monitor_status(control_protocol_resources, oid, status.as_integer(), status_message_string,
nc::details::set_monitor_status_internal(control_protocol_resources, oid, status.as_integer(), status_message_string,
domain_status.status_property_id,
domain_status.status_message_property_id,
domain_status.status_transition_counter_property_id,
domain_status.status_pending_received_time_field_name,
get_control_protocol_class_descriptor,
get_monitor_domains,
gate);

model.notify();
Expand Down
Loading
Loading