iceoryx_posh/popo/wait_set.hpp

Namespaces

Name
iox
iox::popo

Classes

	Name
class	iox::popo::WaitSet Logical disjunction of a certain number of Triggers.

Source code

// Copyright (c) 2020 - 2021 by Robert Bosch GmbH. All rights reserved.
// Copyright (c) 2020 - 2021 by Apex.AI Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
#ifndef IOX_POSH_POPO_WAIT_SET_HPP
#define IOX_POSH_POPO_WAIT_SET_HPP

#include "iceoryx_hoofs/cxx/algorithm.hpp"
#include "iceoryx_hoofs/cxx/function_ref.hpp"
#include "iceoryx_hoofs/cxx/helplets.hpp"
#include "iceoryx_hoofs/cxx/list.hpp"
#include "iceoryx_hoofs/cxx/method_callback.hpp"
#include "iceoryx_hoofs/cxx/stack.hpp"
#include "iceoryx_hoofs/cxx/vector.hpp"
#include "iceoryx_posh/iceoryx_posh_types.hpp"
#include "iceoryx_posh/internal/popo/building_blocks/condition_listener.hpp"
#include "iceoryx_posh/internal/popo/building_blocks/condition_variable_data.hpp"
#include "iceoryx_posh/popo/enum_trigger_type.hpp"
#include "iceoryx_posh/popo/notification_attorney.hpp"
#include "iceoryx_posh/popo/notification_callback.hpp"
#include "iceoryx_posh/popo/notification_info.hpp"
#include "iceoryx_posh/popo/trigger.hpp"
#include "iceoryx_posh/popo/trigger_handle.hpp"
#include "iceoryx_posh/runtime/posh_runtime.hpp"

#include <typeinfo>

namespace iox
{
namespace popo
{
class Condition;

enum class WaitSetError : uint8_t
{
    WAIT_SET_FULL,
    ALREADY_ATTACHED,
};


template <uint64_t Capacity = MAX_NUMBER_OF_ATTACHMENTS_PER_WAITSET>
class WaitSet
{
  public:
    static constexpr uint64_t CAPACITY = Capacity;
    using TriggerArray = cxx::optional<Trigger>[Capacity];
    using NotificationInfoVector = cxx::vector<const NotificationInfo*, CAPACITY>;

    WaitSet() noexcept;
    ~WaitSet() noexcept;

    WaitSet(const WaitSet& rhs) = delete;
    WaitSet(WaitSet&& rhs) = delete;
    WaitSet& operator=(const WaitSet& rhs) = delete;
    WaitSet& operator=(WaitSet&& rhs) = delete;

    void markForDestruction() noexcept;

    template <typename T,
              typename EventType,
              typename ContextDataType = internal::NoType_t,
              typename = std::enable_if_t<std::is_enum<EventType>::value>>
    cxx::expected<WaitSetError>
    attachEvent(T& eventOrigin,
                const EventType eventType,
                const uint64_t notificationId = 0U,
                const NotificationCallback<T, ContextDataType>& eventCallback = {}) noexcept;

    template <typename T,
              typename EventType,
              typename ContextDataType = internal::NoType_t,
              typename = std::enable_if_t<std::is_enum<EventType>::value, void>>
    cxx::expected<WaitSetError> attachEvent(T& eventOrigin,
                                            const EventType eventType,
                                            const NotificationCallback<T, ContextDataType>& eventCallback) noexcept;

    template <typename T, typename ContextDataType = internal::NoType_t>
    cxx::expected<WaitSetError>
    attachEvent(T& eventOrigin,
                const uint64_t notificationId = 0U,
                const NotificationCallback<T, ContextDataType>& eventCallback = {}) noexcept;

    template <typename T, typename ContextDataType = internal::NoType_t>
    cxx::expected<WaitSetError> attachEvent(T& eventOrigin,
                                            const NotificationCallback<T, ContextDataType>& eventCallback) noexcept;

    template <typename T,
              typename StateType,
              typename ContextDataType = internal::NoType_t,
              typename = std::enable_if_t<std::is_enum<StateType>::value>>
    cxx::expected<WaitSetError>
    attachState(T& stateOrigin,
                const StateType stateType,
                const uint64_t id = 0U,
                const NotificationCallback<T, ContextDataType>& stateCallback = {}) noexcept;

    template <typename T,
              typename StateType,
              typename ContextDataType = internal::NoType_t,
              typename = std::enable_if_t<std::is_enum<StateType>::value, void>>
    cxx::expected<WaitSetError> attachState(T& stateOrigin,
                                            const StateType stateType,
                                            const NotificationCallback<T, ContextDataType>& stateCallback) noexcept;

    template <typename T, typename ContextDataType = internal::NoType_t>
    cxx::expected<WaitSetError>
    attachState(T& stateOrigin,
                const uint64_t id = 0U,
                const NotificationCallback<T, ContextDataType>& stateCallback = {}) noexcept;

    template <typename T, typename ContextDataType = internal::NoType_t>
    cxx::expected<WaitSetError> attachState(T& stateOrigin,
                                            const NotificationCallback<T, ContextDataType>& stateCallback) noexcept;

    template <typename T, typename... Targs>
    void detachEvent(T& eventOrigin, const Targs&... args) noexcept;

    template <typename T, typename... Targs>
    void detachState(T& stateOrigin, const Targs&... args) noexcept;

    NotificationInfoVector timedWait(const units::Duration timeout) noexcept;

    NotificationInfoVector wait() noexcept;

    uint64_t size() const noexcept;

    static constexpr uint64_t capacity() noexcept;

  protected:
    explicit WaitSet(ConditionVariableData& condVarData) noexcept;

  private:
    enum class NoStateEnumUsed : StateEnumIdentifier
    {
        PLACEHOLDER
    };

    enum class NoEventEnumUsed : EventEnumIdentifier
    {
        PLACEHOLDER
    };

    using WaitFunction = cxx::function_ref<ConditionListener::NotificationVector_t()>;
    template <typename T, typename ContextDataType>
    cxx::expected<uint64_t, WaitSetError> attachImpl(T& eventOrigin,
                                                     const WaitSetIsConditionSatisfiedCallback& hasTriggeredCallback,
                                                     const uint64_t notificationId,
                                                     const NotificationCallback<T, ContextDataType>& eventCallback,
                                                     const uint64_t originType,
                                                     const uint64_t originTypeHash) noexcept;

    NotificationInfoVector waitAndReturnTriggeredTriggers(const WaitFunction& wait) noexcept;
    NotificationInfoVector createVectorWithTriggeredTriggers() noexcept;

    void removeTrigger(const uint64_t uniqueTriggerId) noexcept;
    void removeAllTriggers() noexcept;
    void acquireNotifications(const WaitFunction& wait) noexcept;

  private:
    TriggerArray m_triggerArray;
    ConditionVariableData* m_conditionVariableDataPtr{nullptr};
    ConditionListener m_conditionListener;

    cxx::stack<uint64_t, Capacity> m_indexRepository;
    ConditionListener::NotificationVector_t m_activeNotifications;
};

} // namespace popo
} // namespace iox

#include "iceoryx_posh/internal/popo/wait_set.inl"

#endif // IOX_POSH_POPO_WAIT_SET_HPP

---

Updated on 2 April 2022 at 16:37:47 CEST