iceoryx_posh/internal/runtime/ipc_message.hpp

Namespaces

Name
iox
iox::runtime

Classes

	Name
class	iox::runtime::IpcMessage

Source code

// Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
// 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_POSH_RUNTIME_IPC_MESSAGE_HPP
#define IOX_POSH_RUNTIME_IPC_MESSAGE_HPP

#include "iceoryx_posh/internal/log/posh_logging.hpp"

#include <cstdint>
#include <sstream>
#include <string>

namespace iox
{
namespace runtime
{
class IpcMessage
{
  public:
    IpcMessage() noexcept = default;

    IpcMessage(const std::initializer_list<std::string>& msg) noexcept;

    IpcMessage(const std::string& msg) noexcept;

    template <typename T>
    IpcMessage& operator<<(const T& entry) noexcept;

    uint32_t getNumberOfElements() const noexcept;

    //          If the message is invalid the return value is undefined.
    std::string getElementAtIndex(const uint32_t index) const noexcept;

    bool isValidEntry(const std::string& entry) const noexcept;

    bool isValid() const noexcept;

    std::string getMessage() const noexcept;

    void setMessage(const std::string& msg) noexcept;

    //      message becomes valid again.
    void clearMessage() noexcept;

    template <typename T>
    void addEntry(const T& entry) noexcept;

    bool operator==(const IpcMessage& rhs) const noexcept;

  private:
    static const char m_separator; // default value is ,
    std::string m_msg;
    bool m_isValid{true};
    uint32_t m_numberOfElements{0};
};

} // namespace runtime
} // namespace iox


#include "iceoryx_posh/internal/runtime/ipc_message.inl"

#endif // IOX_POSH_RUNTIME_IPC_MESSAGE_HPP

---

Updated on 31 May 2022 at 15:29:16 CEST