Added bool to onUnsolicitedRegistrationChanged: triggeredByEntity

Author: christophe-calmejane

CHANGELOG-controller.md

@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Changed
 - [StreamOutputNode has a new field: `presentationTimeOffset` to replace the `msrpAccumulatedLatency` field (which was in StreamDynamicInfo struct)](https://github.com/L-Acoustics/avdecc/issues/147)
 - StreamDynamicInfo.hasSrpRegistrationFailed replaces the deprecated hasTalkerFailed field
+- New boolean parameter _triggeredByEntity_ in onUnsolicitedRegistrationChanged event to know if the change was triggered by the entity itself or by the controller
 
 ### Fixed
 - `computeEntityModelChecksum` not returning a deterministic value for all OSes

include/la/avdecc/controller/avdeccController.hpp

@@ -258,7 +258,7 @@ class Controller : public la::avdecc::utils::Subject<Controller, std::recursive_
 		virtual void onGptpChanged(la::avdecc::controller::Controller const* const controller, la::avdecc::controller::ControlledEntity const* const entity, la::avdecc::entity::model::AvbInterfaceIndex const avbInterfaceIndex, la::avdecc::UniqueIdentifier const grandMasterID, std::uint8_t const grandMasterDomain) noexcept = 0;
 
 		// Global entity notifications
-		virtual void onUnsolicitedRegistrationChanged(la::avdecc::controller::Controller const* const controller, la::avdecc::controller::ControlledEntity const* const entity, bool const isSubscribed) noexcept = 0;
+		virtual void onUnsolicitedRegistrationChanged(la::avdecc::controller::Controller const* const controller, la::avdecc::controller::ControlledEntity const* const entity, bool const isSubscribed, bool const triggeredByEntity) noexcept = 0;
 		virtual void onCompatibilityChanged(la::avdecc::controller::Controller const* const controller, la::avdecc::controller::ControlledEntity const* const entity, la::avdecc::controller::ControlledEntity::CompatibilityFlags const compatibilityFlags, la::avdecc::entity::model::MilanVersion const& milanCompatibleVersion) noexcept = 0;
 		virtual void onIdentificationStarted(la::avdecc::controller::Controller const* const controller, la::avdecc::controller::ControlledEntity const* const entity) noexcept = 0;
 		virtual void onIdentificationStopped(la::avdecc::controller::Controller const* const controller, la::avdecc::controller::ControlledEntity const* const entity) noexcept = 0;
@@ -359,7 +359,7 @@ class Controller : public la::avdecc::utils::Subject<Controller, std::recursive_
 		virtual void onGptpChanged(la::avdecc::controller::Controller const* const /*controller*/, la::avdecc::controller::ControlledEntity const* const /*entity*/, la::avdecc::entity::model::AvbInterfaceIndex const /*avbInterfaceIndex*/, la::avdecc::UniqueIdentifier const /*grandMasterID*/, std::uint8_t const /*grandMasterDomain*/) noexcept override {}
 
 		// Global entity notifications
-		virtual void onUnsolicitedRegistrationChanged(la::avdecc::controller::Controller const* const /*controller*/, la::avdecc::controller::ControlledEntity const* const /*entity*/, bool const /*isSubscribed*/) noexcept override {}
+		virtual void onUnsolicitedRegistrationChanged(la::avdecc::controller::Controller const* const /*controller*/, la::avdecc::controller::ControlledEntity const* const /*entity*/, bool const /*isSubscribed*/, bool const /*triggeredByEntity*/) noexcept override {}
 		virtual void onCompatibilityChanged(la::avdecc::controller::Controller const* const /*controller*/, la::avdecc::controller::ControlledEntity const* const /*entity*/, la::avdecc::controller::ControlledEntity::CompatibilityFlags const /*compatibilityFlags*/, la::avdecc::entity::model::MilanVersion const& /*milanCompatibleVersion*/) noexcept override {}
 		virtual void onIdentificationStarted(la::avdecc::controller::Controller const* const /*controller*/, la::avdecc::controller::ControlledEntity const* const /*entity*/) noexcept override {}
 		virtual void onIdentificationStopped(la::avdecc::controller::Controller const* const /*controller*/, la::avdecc::controller::ControlledEntity const* const /*entity*/) noexcept override {}

src/controller/avdeccControllerImpl.cpp

@@ -381,7 +381,7 @@ void ControllerImpl::decreaseMilanCompatibilityVersion(ControllerImpl const* con
 	}
 }
 
-void ControllerImpl::updateUnsolicitedNotificationsSubscription(ControlledEntityImpl& controlledEntity, bool const isSubscribed) const noexcept
+void ControllerImpl::updateUnsolicitedNotificationsSubscription(ControlledEntityImpl& controlledEntity, bool const isSubscribed, bool const triggeredByEntity) const noexcept
 {
 	AVDECC_ASSERT(_controller->isSelfLocked(), "Should only be called from the network thread (where ProtocolInterface is locked)");
 
@@ -394,7 +394,7 @@ void ControllerImpl::updateUnsolicitedNotificationsSubscription(ControlledEntity
 		// Entity was advertised to the user, notify observers
 		if (controlledEntity.wasAdvertised())
 		{
-			notifyObserversMethod<Controller::Observer>(&Controller::Observer::onUnsolicitedRegistrationChanged, this, &controlledEntity, isSubscribed);
+			notifyObserversMethod<Controller::Observer>(&Controller::Observer::onUnsolicitedRegistrationChanged, this, &controlledEntity, isSubscribed, triggeredByEntity);
 		}
 	}
 }

src/controller/avdeccControllerImpl.hpp

@@ -361,7 +361,7 @@ class ControllerImpl final : public Controller, private entity::controller::Dele
 	static void setMilanWarningCompatibilityFlag(ControllerImpl const* const controller, ControlledEntityImpl& controlledEntity, std::string const& specClause, std::string const& message) noexcept;
 	static void removeCompatibilityFlag(ControllerImpl const* const controller, ControlledEntityImpl& controlledEntity, ControlledEntity::CompatibilityFlag const flag, std::string const& specClause, std::string const& message) noexcept;
 	static void decreaseMilanCompatibilityVersion(ControllerImpl const* const controller, ControlledEntityImpl& controlledEntity, entity::model::MilanVersion const& version, std::string const& specClause, std::string const& message) noexcept;
-	void updateUnsolicitedNotificationsSubscription(ControlledEntityImpl& controlledEntity, bool const isSubscribed) const noexcept;
+	void updateUnsolicitedNotificationsSubscription(ControlledEntityImpl& controlledEntity, bool const isSubscribed, bool const triggeredByEntity) const noexcept;
 	void updateAcquiredState(ControlledEntityImpl& controlledEntity, model::AcquireState const acquireState, UniqueIdentifier const owningEntity) const noexcept;
 	void updateLockedState(ControlledEntityImpl& controlledEntity, model::LockState const lockState, UniqueIdentifier const lockingEntity) const noexcept;
 	void updateConfiguration(entity::controller::Interface const* const controller, ControlledEntityImpl& controlledEntity, entity::model::ConfigurationIndex const configurationIndex, TreeModelAccessStrategy::NotFoundBehavior const notFoundBehavior) const noexcept;

src/controller/avdeccControllerImplDelegateOverrides.cpp

@@ -236,7 +236,7 @@ void ControllerImpl::onDeregisteredFromUnsolicitedNotifications(entity::controll
 	if (controlledEntity)
 	{
 		auto& entity = *controlledEntity;
-		updateUnsolicitedNotificationsSubscription(entity, false);
+		updateUnsolicitedNotificationsSubscription(entity, false, true);
 	}
 }
 
@@ -1081,7 +1081,7 @@ void ControllerImpl::handleAecpUnsolicitedReceived(UniqueIdentifier const& entit
 			// As part of #50 (for now), just unsubscribe from unsolicited notifications
 			{
 				// Immediately set as unsubscribed, we are already loosing packets we don't want to miss the response to our unsubscribe
-				updateUnsolicitedNotificationsSubscription(entity, false);
+				updateUnsolicitedNotificationsSubscription(entity, false, false);
 
 				// Properly (try to) unregister from unsol
 				unregisterUnsol(&entity);

src/controller/avdeccControllerImplHandlers.cpp

@@ -691,7 +691,7 @@ void ControllerImpl::onUnregisterUnsolicitedNotificationsResult(entity::controll
 
 		if (!!status)
 		{
-			entity.setSubscribedToUnsolicitedNotifications(false);
+			updateUnsolicitedNotificationsSubscription(entity, false, false);
 		}
 	}
 }