chunk_settings.hpp🔗

Namespaces🔗

Name
iox
iox::mepoo
Classes🔗

	Name
class	iox::mepoo::ChunkSettings
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_POSH_MEPOO_CHUNK_SETTINGS_HPP
#define IOX_POSH_MEPOO_CHUNK_SETTINGS_HPP

#include "iceoryx_hoofs/cxx/expected.hpp"
#include "iceoryx_posh/iceoryx_posh_types.hpp"

#include <cstdint>

namespace iox
{
namespace mepoo
{
class ChunkSettings
{
  public:
    enum class Error
    {
        ALIGNMENT_NOT_POWER_OF_TWO,
        USER_HEADER_ALIGNMENT_EXCEEDS_CHUNK_HEADER_ALIGNMENT,
        USER_HEADER_SIZE_NOT_MULTIPLE_OF_ITS_ALIGNMENT,
        REQUIRED_CHUNK_SIZE_EXCEEDS_MAX_CHUNK_SIZE,
    };

    static cxx::expected<ChunkSettings, ChunkSettings::Error>
    create(const uint32_t userPayloadSize,
           const uint32_t userPayloadAlignment = iox::CHUNK_DEFAULT_USER_PAYLOAD_ALIGNMENT,
           const uint32_t userHeaderSize = iox::CHUNK_NO_USER_HEADER_SIZE,
           const uint32_t userHeaderAlignment = iox::CHUNK_NO_USER_HEADER_ALIGNMENT) noexcept;

    uint32_t requiredChunkSize() const noexcept;

    uint32_t userPayloadSize() const noexcept;

    uint32_t userPayloadAlignment() const noexcept;

    uint32_t userHeaderSize() const noexcept;

    uint32_t userHeaderAlignment() const noexcept;

  private:
    ChunkSettings(const uint32_t userPayloadSize,
                  const uint32_t userPayloadAlignment,
                  const uint32_t userHeaderSize,
                  const uint32_t userHeaderAlignment,
                  const uint32_t requiredChunkSize) noexcept;

    static uint64_t calculateRequiredChunkSize(const uint32_t userPayloadSize,
                                               const uint32_t userPayloadAlignment,
                                               const uint32_t userHeaderSize) noexcept;

  private:
    uint32_t m_userPayloadSize{0U};
    uint32_t m_userPayloadAlignment{0U};
    uint32_t m_userHeaderSize{0U};
    uint32_t m_userHeaderAlignment{0U};
    uint32_t m_requiredChunkSize{0U};
};

} // namespace mepoo
} // namespace iox

#endif // IOX_POSH_MEPOO_CHUNK_SETTINGS_HPP
Updated on 18 December 2023 at 13:11:43 CET