iceoryx_posh/internal/popo/ports/base_port.hpp

Namespaces

Name
iox
iox::popo

Classes

	Name
class	iox::popo::BasePort this class is the base for all ports. it is constructed from a member pointer and is only movable. only movable rational: a port has only one member, a pointer to its data. if a port is copied then both ports would work on the same data even though these are two independent copies. this would case a weird shared state, race conditions and so on

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_POPO_PORTS_BASE_PORT_HPP
#define IOX_POSH_POPO_PORTS_BASE_PORT_HPP

#include "iceoryx_posh/iceoryx_posh_types.hpp"
#include "iceoryx_posh/internal/popo/ports/base_port_data.hpp"

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

    explicit BasePort(MemberType_t* const basePortDataPtr) noexcept;

    BasePort(const BasePort& other) = delete;
    BasePort& operator=(const BasePort&) = delete;
    BasePort(BasePort&&) noexcept;
    BasePort& operator=(BasePort&&) noexcept;
    virtual ~BasePort() = default;

    operator bool() const noexcept;

    capro::ServiceDescription getCaProServiceDescription() const noexcept;

    RuntimeName_t getRuntimeName() const noexcept;

    UniquePortId getUniqueID() const noexcept;

    NodeName_t getNodeName() const noexcept;

    void destroy() noexcept;

    bool toBeDestroyed() const noexcept;

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

  private:
    MemberType_t* m_basePortDataPtr;
};

} // namespace popo
} // namespace iox

#include "iceoryx_posh/internal/popo/ports/base_port.inl"

#endif // IOX_POSH_POPO_PORTS_BASE_PORT_HPP

---

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