iceoryx_hoofs/posix_wrapper/named_pipe.hpp🔗
Namespaces🔗
Name |
---|
iox building block to easily create free function for logging in a library context |
iox::posix |
Classes🔗
Name | |
---|---|
class | iox::posix::NamedPipe |
Source code🔗
// Copyright (c) 2021 by Apex.AI Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
#ifndef IOX_HOOFS_POSIX_WRAPPER_NAMED_PIPE_HPP
#define IOX_HOOFS_POSIX_WRAPPER_NAMED_PIPE_HPP
#include "iceoryx_hoofs/concurrent/lockfree_queue.hpp"
#include "iceoryx_hoofs/cxx/string.hpp"
#include "iceoryx_hoofs/design_pattern/creation.hpp"
#include "iceoryx_hoofs/internal/posix_wrapper/ipc_channel.hpp"
#include "iceoryx_hoofs/internal/posix_wrapper/shared_memory_object.hpp"
#include "iceoryx_hoofs/internal/units/duration.hpp"
#include "iceoryx_hoofs/posix_wrapper/semaphore.hpp"
#include <cstdint>
namespace iox
{
namespace posix
{
class NamedPipe : public DesignPattern::Creation<NamedPipe, IpcChannelError>
{
public:
// no system restrictions at all, except available memory. MAX_MESSAGE_SIZE and MAX_NUMBER_OF_MESSAGES can be
// increased as long as there is enough memory available
static constexpr uint64_t MAX_MESSAGE_SIZE = 4U * 1024U;
static constexpr uint64_t MAX_NUMBER_OF_MESSAGES = 10U;
static constexpr uint64_t NULL_TERMINATOR_SIZE = 0U;
static constexpr units::Duration CYCLE_TIME = units::Duration::fromMilliseconds(10);
static constexpr const char NAMED_PIPE_PREFIX[] = "iox_np_";
using Message_t = cxx::string<MAX_MESSAGE_SIZE>;
using MessageQueue_t = concurrent::LockFreeQueue<Message_t, MAX_NUMBER_OF_MESSAGES>;
NamedPipe(const NamedPipe&) = delete;
NamedPipe& operator=(const NamedPipe&) = delete;
NamedPipe() noexcept;
NamedPipe(NamedPipe&& rhs) noexcept;
NamedPipe& operator=(NamedPipe&& rhs) noexcept;
~NamedPipe() noexcept;
cxx::expected<IpcChannelError> destroy() noexcept;
static cxx::expected<bool, IpcChannelError> unlinkIfExists(const IpcChannelName_t& name) noexcept;
cxx::expected<bool, IpcChannelError> isOutdated() noexcept;
cxx::expected<IpcChannelError> trySend(const std::string& message) const noexcept;
cxx::expected<IpcChannelError> send(const std::string& message) const noexcept;
cxx::expected<IpcChannelError> timedSend(const std::string& message, const units::Duration& timeout) const noexcept;
cxx::expected<std::string, IpcChannelError> tryReceive() const noexcept;
cxx::expected<std::string, IpcChannelError> receive() const noexcept;
cxx::expected<std::string, IpcChannelError> timedReceive(const units::Duration& timeout) const noexcept;
private:
friend class DesignPattern::Creation<NamedPipe, IpcChannelError>;
NamedPipe(const IpcChannelName_t& name,
const IpcChannelSide channelSide,
const size_t maxMsgSize = MAX_MESSAGE_SIZE,
const uint64_t maxMsgNumber = MAX_NUMBER_OF_MESSAGES) noexcept;
template <typename Prefix>
static IpcChannelName_t convertName(const Prefix& p, const IpcChannelName_t& name) noexcept;
private:
cxx::optional<SharedMemoryObject> m_sharedMemory;
class NamedPipeData
{
public:
NamedPipeData(bool& isInitialized, IpcChannelError& error, const uint64_t maxMsgNumber) noexcept;
NamedPipeData(const NamedPipeData&) = delete;
NamedPipeData(NamedPipeData&& rhs) = delete;
~NamedPipeData() noexcept;
NamedPipeData& operator=(const NamedPipeData&) = delete;
NamedPipeData& operator=(NamedPipeData&& rhs) = delete;
Semaphore& sendSemaphore() noexcept;
Semaphore& receiveSemaphore() noexcept;
bool waitForInitialization() const noexcept;
bool hasValidState() const noexcept;
MessageQueue_t messages;
private:
static constexpr uint64_t SEND_SEMAPHORE = 0U;
static constexpr uint64_t RECEIVE_SEMAPHORE = 1U;
static constexpr uint64_t INVALID_DATA = 0xBAADF00DAFFEDEAD;
static constexpr uint64_t VALID_DATA = 0xBAD0FF1CEBEEFBEE;
static constexpr units::Duration WAIT_FOR_INIT_TIMEOUT = units::Duration::fromSeconds(1);
static constexpr units::Duration WAIT_FOR_INIT_SLEEP_TIME = units::Duration::fromMilliseconds(1);
std::atomic<uint64_t> initializationGuard{INVALID_DATA};
using semaphoreMemory_t = uint8_t[sizeof(Semaphore)];
alignas(Semaphore) semaphoreMemory_t semaphores[2U];
};
NamedPipeData* m_data = nullptr;
};
} // namespace posix
} // namespace iox
#endif
Updated on 17 March 2022 at 12:15:57 CET