iceoryx2
C++ Language Bindings
Loading...
Searching...
No Matches
header_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_HEADER_PUBLISH_SUBSCRIBE_HPP
14
#define IOX2_HEADER_PUBLISH_SUBSCRIBE_HPP
15
16
#include "
iox2/internal/iceoryx2.hpp
"
17
#include "
unique_port_id.hpp
"
18
19
namespace
iox2
{
21
class
HeaderPublishSubscribe
{
22
public
:
23
HeaderPublishSubscribe
(
const
HeaderPublishSubscribe
&) =
delete
;
24
HeaderPublishSubscribe
(
HeaderPublishSubscribe
&& rhs)
noexcept
;
25
auto
operator=
(
const
HeaderPublishSubscribe
&) ->
HeaderPublishSubscribe
& =
delete
;
26
auto
operator=
(
HeaderPublishSubscribe
&& rhs)
noexcept
->
HeaderPublishSubscribe
&;
27
~HeaderPublishSubscribe
();
28
30
auto
publisher_id
() const ->
UniquePublisherId
;
31
33
auto
number_of_elements
() const -> uint64_t;
34
35
private:
36
template <
ServiceType
, typename, typename>
37
friend class
Sample
;
38
template <
ServiceType
, typename, typename>
39
friend class
SampleMut
;
40
41
explicit
HeaderPublishSubscribe
(iox2_publish_subscribe_header_h handle);
42
void
drop();
43
44
iox2_publish_subscribe_header_h m_handle =
nullptr
;
45
};
46
}
// namespace iox2
47
48
#endif
iox2::HeaderPublishSubscribe
Sample header used by [MessagingPattern::PublishSubscribe].
Definition
header_publish_subscribe.hpp:21
iox2::HeaderPublishSubscribe::HeaderPublishSubscribe
HeaderPublishSubscribe(const HeaderPublishSubscribe &)=delete
iox2::HeaderPublishSubscribe::~HeaderPublishSubscribe
~HeaderPublishSubscribe()
iox2::HeaderPublishSubscribe::operator=
auto operator=(const HeaderPublishSubscribe &) -> HeaderPublishSubscribe &=delete
iox2::HeaderPublishSubscribe::number_of_elements
auto number_of_elements() const -> uint64_t
Returns the number of [Payload] elements in the received [Sample].
iox2::HeaderPublishSubscribe::HeaderPublishSubscribe
HeaderPublishSubscribe(HeaderPublishSubscribe &&rhs) noexcept
iox2::HeaderPublishSubscribe::operator=
auto operator=(HeaderPublishSubscribe &&rhs) noexcept -> HeaderPublishSubscribe &
iox2::HeaderPublishSubscribe::publisher_id
auto publisher_id() const -> UniquePublisherId
Returns the [UniquePublisherId] of the source [Publisher].
iox2::SampleMut
Definition
sample_mut.hpp:50
iox2::Sample
Definition
sample.hpp:41
iox2::UniquePublisherId
The system-wide unique id of a [Publisher].
Definition
unique_port_id.hpp:26
iceoryx2.hpp
iox2
Definition
active_request.hpp:26
iox2::ServiceType
ServiceType
Definition
service_type.hpp:21
unique_port_id.hpp
iox2
header_publish_subscribe.hpp
Generated by
1.9.8