iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
static_config_publish_subscribe.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_STATIC_CONFIG_PUBLISH_SUBSCRIBE_HPP
14#define IOX2_STATIC_CONFIG_PUBLISH_SUBSCRIBE_HPP
15
19
20#include <cstdint>
21
22namespace iox2 {
27 public:
30 auto max_nodes() const -> uint64_t;
31
33 auto max_publishers() const -> uint64_t;
34
36 auto max_subscribers() const -> uint64_t;
37
39 auto history_size() const -> uint64_t;
40
42 auto subscriber_max_buffer_size() const -> uint64_t;
43
45 auto subscriber_max_borrowed_samples() const -> uint64_t;
46
50 auto has_safe_overflow() const -> bool;
51
54
55 private:
56 template <ServiceType, typename, typename>
58 friend class StaticConfig;
59
60 explicit StaticConfigPublishSubscribe(iox2_static_config_publish_subscribe_t value);
61
62 iox2_static_config_publish_subscribe_t m_value;
63};
64} // namespace iox2
65
66auto operator<<(std::ostream& stream, const iox2::StaticConfigPublishSubscribe& value) -> std::ostream&;
67
68#endif
Contains all type information to the header and payload type.
auto has_safe_overflow() const -> bool
auto subscriber_max_buffer_size() const -> uint64_t
Returns the maximum supported buffer size for [Subscriber] port.
auto subscriber_max_borrowed_samples() const -> uint64_t
Returns how many [Sample]s a [Subscriber] port can borrow in parallel at most.
auto max_publishers() const -> uint64_t
Returns the maximum supported amount of [Publisher] ports.
auto history_size() const -> uint64_t
Returns the maximum history size that can be requested on connect.
auto max_nodes() const -> uint64_t
auto message_type_details() const -> MessageTypeDetails
Returns the type details of the [Service].
auto max_subscribers() const -> uint64_t
Returns the maximum supported amount of [Subscriber] ports.
Defines a common set of static service configuration details every service shares.