/* mergeproxyuniverse.h Copyright (c) 2021 Kevin Matz (kevin.matz@gmail.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #pragma once #include "universe.h" #include #include namespace sACN { /** * @brief Priority based selection of multiple source universes * * * > \cite sACN 6.2.3.1 Multiple Sources at Highest Priority * > * > It is possible for there to be multiple sources, all transmitting data * > at the highest currently active priority for a given universe. When this * > occurs, receivers must handle these sources in some way. * * If multiple universes with highest priority are recieved, the universe * recieved most recently will be given dominance. * * > \cite sACN 6.2.3.2 Note on Merge and Arbitration Algorithms * > * > A process which selects between candidate sources based on some * > additional selection criterion is called arbitration. * * The universe with the highest priority will be determined to be the * dominant source. */ class ArbitratingUniverse : public sACN::Universe { public: explicit ArbitratingUniverse(); uint16_t expectedUniverse; ///< Expected universe number void setHoldLastLook(const bool); bool getHoldLastLook() const; // Source universes: void deleteSourceUniverse(const DATA::data_header&); void dataChangedNotifier(DMX::Universe* universe); // DMX::Universe overrides: virtual uint8_t status() const override; uint8_t slot(const uint16_t) const override; double rxRate() override; // sACN::Universe Overrides std::shared_ptr metadata() const override; void setMetadata(std::shared_ptr) override {}; bool isSyncronized() const override; void synchronize(uint8_t = 0) override; bool isEditable() const override; uint16_t activeSlots() const override; // api for poly-source universes const std::vector sources() const override; std::shared_ptr sourceUniverse(const DATA::data_header&) override; std::shared_ptr addNewSource(const DATA::data_header&) override; std::shared_ptr onSourceListChange(std::function) override; protected: void doListChangeCallbacks(); // ACN::DMP::Component overrides virtual void rxDmpSetProperty(ACN::PDU::Message) override; private: std::unordered_map> sources_; std::vector> source_data_tokens; //!< source universe data change tokens std::vector>> cb_sourceListChange; //!< list of calback functions std::vector> source_status_tokens; //!< source universe data change tokens bool hold_last_look_; std::shared_ptr dominant_() const; void purge_stale_sources_(); bool hasSourceUniverse(const DATA::data_header&) const; }; } // SACN namespace