iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
node_details.hpp
Go to the documentation of this file.
1// Copyright (c) 2024 Contributors to the Eclipse Foundation
2//
3// See the NOTICE file(s) distributed with this work for additional
4// information regarding copyright ownership.
5//
6// This program and the accompanying materials are made available under the
7// terms of the Apache Software License 2.0 which is available at
8// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
9// which is available at https://opensource.org/licenses/MIT.
10//
11// SPDX-License-Identifier: Apache-2.0 OR MIT
12
13#ifndef IOX2_NODE_DETAILS_HPP
14#define IOX2_NODE_DETAILS_HPP
15
16#include "iox2/bb/file_name.hpp"
17#include "iox2/config.hpp"
18#include "iox2/node_name.hpp"
19
20namespace iox2 {
23 public:
25 auto executable() const -> const iox2::bb::FileName&;
27 auto name() const -> const NodeName&;
29 auto config() const -> const Config&;
30
31 private:
32 template <ServiceType>
33 friend auto internal::list_callback(iox2_node_state_e,
34 iox2_unique_node_id_ptr,
35 const char* executable,
36 iox2_node_name_ptr,
37 iox2_config_ptr,
38 iox2_callback_context) -> iox2_callback_progression_e;
39
41
42 iox2::bb::FileName m_executable;
43 NodeName m_node_name;
44 Config m_config;
45};
46} // namespace iox2
47
48#endif
Contains details of a [Node].
auto config() const -> const Config &
Returns a reference to the [Config] the [Node] uses.
auto name() const -> const NodeName &
Returns a reference of the [NodeName].
friend auto internal::list_callback(iox2_node_state_e, iox2_unique_node_id_ptr, const char *executable, iox2_node_name_ptr, iox2_config_ptr, iox2_callback_context) -> iox2_callback_progression_e
auto executable() const -> const iox2::bb::FileName &
Returns the executable [FileName] of the [Node]s owner process.
Represent the name for a [Node].
Definition node_name.hpp:64