iceoryx_doc  1.0.1
ipc_interface_user.hpp
1 // Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
2 // Copyright (c) 2021 by Apex.AI Inc. All rights reserved.
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 // http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 //
16 // SPDX-License-Identifier: Apache-2.0
17 
18 #ifndef IOX_POSH_RUNTIME_IPC_INTERFACE_USER_HPP
19 #define IOX_POSH_RUNTIME_IPC_INTERFACE_USER_HPP
20 
21 #include "iceoryx_posh/internal/runtime/ipc_interface_base.hpp"
22 
23 namespace iox
24 {
25 namespace runtime
26 {
29 {
30  public:
37  IpcInterfaceUser(const RuntimeName_t& name,
38  const uint64_t maxMessages = APP_MAX_MESSAGES,
39  const uint64_t messageSize = APP_MESSAGE_SIZE) noexcept;
40 
45  IpcInterfaceUser& operator=(const IpcInterfaceUser&) = delete;
46 
49  IpcInterfaceUser& operator=(IpcInterfaceUser&&) = delete;
50 };
51 
52 } // namespace runtime
53 } // namespace iox
54 
55 #endif // IOX_POSH_RUNTIME_IPC_INTERFACE_USER_HPP
Base-Class should never be used by the end-user. Handles the common properties and methods for the ch...
Definition: ipc_interface_base.hpp:127
Class for using a IPC channel.
Definition: ipc_interface_user.hpp:29
IpcInterfaceUser(const RuntimeName_t &name, const uint64_t maxMessages=APP_MAX_MESSAGES, const uint64_t messageSize=APP_MESSAGE_SIZE) noexcept
Constructs a IpcInterfaceUser and opens a IPC channel. Therefore, isInitialized should always be call...
IpcInterfaceUser(IpcInterfaceUser &&)=delete
Not needed therefore deleted.
IpcInterfaceUser(const IpcInterfaceUser &)=delete
The copy constructor and assignment operator are deleted since this class manages a resource (IPC cha...
Definition: service_description.hpp:29