iceoryx_posh 2.0.5
Loading...
Searching...
No Matches
notification_info.hpp
1// Copyright (c) 2020, 2021 by Apex.AI Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15// SPDX-License-Identifier: Apache-2.0
16
17#ifndef IOX_POSH_POPO_NOTIFICATION_INFO_HPP
18#define IOX_POSH_POPO_NOTIFICATION_INFO_HPP
19
20#include "iceoryx_hoofs/cxx/function_ref.hpp"
21#include "iceoryx_hoofs/error_handling/error_handling.hpp"
22#include "iceoryx_posh/internal/log/posh_logging.hpp"
23#include "iceoryx_posh/popo/notification_callback.hpp"
24
25#include <cstdint>
26#include <limits>
27
28namespace iox
29{
30namespace popo
31{
35{
36 public:
37 static constexpr uint64_t INVALID_ID = std::numeric_limits<uint64_t>::max();
38
42
51
56
63
70
74
76
78 void* m_notificationOrigin = nullptr;
79 void* m_userValue = nullptr;
80 uint64_t m_notificationOriginTypeHash = 0U;
81 uint64_t m_notificationId = INVALID_ID;
82
83 internal::GenericCallbackPtr_t m_callbackPtr = nullptr;
84 internal::TranslationCallbackPtr_t m_callback = nullptr;
85};
86
87} // namespace popo
88} // namespace iox
89
90#include "iceoryx_posh/internal/popo/notification_info.inl"
91
92#endif
NotificationInfo holds the state of a trigger like the pointer to the triggerOrigin,...
Definition notification_info.hpp:35
NotificationInfo() noexcept=default
constructs an empty NotificationInfo
T * getOrigin() const noexcept
returns the pointer to the notificationOrigin.
bool doesOriginateFrom(T *const notificationOrigin) const noexcept
confirms the notificationOrigin
uint64_t getNotificationId() const noexcept
returns the notification id
The Trigger class is usually managed by a factory class like a WaitSet and acquired by classes which ...
Definition trigger.hpp:56
the struct describes a callback with a user defined type which can be attached to a WaitSet or a List...
Definition notification_callback.hpp:58