iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
static_config_request_response.hpp
Go to the documentation of this file.
1// Copyright (c) 2025 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_REQUEST_RESPONSE_HPP
14#define IOX2_STATIC_CONFIG_REQUEST_RESPONSE_HPP
15
17
18namespace iox2 {
24 public:
27
30
34 auto has_safe_overflow_for_requests() const -> bool;
35
39 auto has_safe_overflow_for_responses() const -> bool;
40
44
46 auto max_active_requests_per_client() const -> uint64_t;
47
49 auto max_response_buffer_size() const -> uint64_t;
50
52 auto max_loaned_requests() const -> uint64_t;
53
57
59 auto max_servers() const -> uint64_t;
60
62 auto max_clients() const -> uint64_t;
63
65 auto max_nodes() const -> uint64_t;
66
67 private:
68 template <ServiceType, typename, typename, typename, typename>
70 friend class StaticConfig;
71
72 explicit StaticConfigRequestResponse(iox2_static_config_request_response_t value);
73
74 iox2_static_config_request_response_t m_value;
75};
76} // namespace iox2
77
78auto operator<<(std::ostream& stream, const iox2::StaticConfigRequestResponse& value) -> std::ostream&;
79
80#endif
Contains all type information to the header and payload type.
auto max_borrowed_responses_per_pending_responses() const -> uint64_t
auto has_safe_overflow_for_requests() const -> bool
auto max_nodes() const -> uint64_t
Returns the maximum number of supported [Node]s for the [Service].
auto max_clients() const -> uint64_t
Returns the maximum number of supported [Client] ports for the [Service].
auto max_active_requests_per_client() const -> uint64_t
Returns the maximum of active requests a [Server] can hold in parallel per [Client].
auto has_safe_overflow_for_responses() const -> bool
auto response_message_type_details() const -> MessageTypeDetails
Returns the response type details of the [Service].
auto max_servers() const -> uint64_t
Returns the maximum number of supported [Server] ports for the [Service].
auto max_response_buffer_size() const -> uint64_t
Returns the maximum buffer size for responses for a [PendingResponse].
auto does_support_fire_and_forget_requests() const -> bool
auto request_message_type_details() const -> MessageTypeDetails
Returns the request type details of the [Service].
auto max_loaned_requests() const -> uint64_t
Returns the maximum number of [RequestMut] a [Client] can loan in parallel.
Defines a common set of static service configuration details every service shares.