iceoryx_posh/internal/popo/ports/publisher_port_user.hpp

Namespaces

Name
iox
iox::popo

Classes

Name

class

iox::popo::PublisherPortUser The PublisherPortUser provides the API for accessing a publisher port from the user side. The publisher port is divided in the three parts PublisherPortData, PublisherPortRouDi and PublisherPortUser. The PublisherPortUser uses the functionality of a ChunkSender for sending shared memory chunks. Additionally it provides the offer / stopOffer API which controls whether the publisher port is discoverable for subscriber ports.

Source code

// Copyright (c) 2020 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_POPO_PORTS_PUBLISHER_PORT_USER_HPP
#define IOX_POSH_POPO_PORTS_PUBLISHER_PORT_USER_HPP

#include "iceoryx_posh/internal/popo/building_blocks/chunk_distributor.hpp"
#include "iceoryx_posh/internal/popo/building_blocks/chunk_sender.hpp"
#include "iceoryx_posh/internal/popo/ports/base_port.hpp"
#include "iceoryx_posh/internal/popo/ports/publisher_port_data.hpp"
#include "iceoryx_posh/mepoo/chunk_header.hpp"
#include "iceoryx_utils/cxx/expected.hpp"
#include "iceoryx_utils/cxx/helplets.hpp"
#include "iceoryx_utils/cxx/optional.hpp"
#include "iceoryx_utils/error_handling/error_handling.hpp"

namespace iox
{
namespace popo
{
class PublisherPortUser : public BasePort
{
  public:
    using MemberType_t = PublisherPortData;

    explicit PublisherPortUser(cxx::not_null<MemberType_t* const> publisherPortDataPtr) noexcept;

    PublisherPortUser(const PublisherPortUser& other) = delete;
    PublisherPortUser& operator=(const PublisherPortUser&) = delete;
    PublisherPortUser(PublisherPortUser&& rhs) = default;
    PublisherPortUser& operator=(PublisherPortUser&& rhs) = default;
    ~PublisherPortUser() = default;

    cxx::expected<mepoo::ChunkHeader*, AllocationError>
    tryAllocateChunk(const uint32_t userPayloadSize,
                     const uint32_t userPayloadAlignment,
                     const uint32_t userHeaderSize = 0U,
                     const uint32_t userHeaderAlignment = 1U) noexcept;

    void releaseChunk(mepoo::ChunkHeader* const chunkHeader) noexcept;

    void sendChunk(mepoo::ChunkHeader* const chunkHeader) noexcept;

    cxx::optional<const mepoo::ChunkHeader*> tryGetPreviousChunk() const noexcept;

    void offer() noexcept;

    void stopOffer() noexcept;

    bool isOffered() const noexcept;

    bool hasSubscribers() const noexcept;

  private:
    const MemberType_t* getMembers() const noexcept;
    MemberType_t* getMembers() noexcept;

    ChunkSender<PublisherPortData::ChunkSenderData_t> m_chunkSender;
};

} // namespace popo
} // namespace iox

#endif // IOX_POSH_POPO_PORTS_PUBLISHER_PORT_USER_HPP

---

Updated on 31 May 2022 at 15:52:35 CEST