Channel.hpp

Go to the documentation of this file.

//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2018-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//

#ifndef DW_FRAMEWORK_CHANNEL_HPP_
#define DW_FRAMEWORK_CHANNEL_HPP_

#include "ChannelParameters.hpp"
#include "IChannelPacket.hpp"

#include <dw/core/context/Context.h>
#include <dwcgf/Exception.hpp>
#include <dw/core/language/Function.hpp>
#include <dw/core/container/BaseString.hpp>

#include <memory>
#include <mutex>
#include <string>

namespace dw
{
namespace framework
{

static constexpr dwTime_t CHN_WAIT_TIMEOUT_US = 50'000'000;

class ChannelObject
{
public:
    virtual ~ChannelObject() = default;

    class SyncClient
    {
    public:
        virtual void getSyncObjs(dw::core::span<NvSciSyncObj>& syncObjs) = 0;
    };

    class SyncWaiter : public SyncClient
    {
    public:
        virtual void getWaitFences(void* data, dw::core::span<NvSciSyncFence>& waitFences) = 0;
    };

    class SyncSignaler : public SyncClient
    {
    public:
        virtual void setSignalFences(void* data, dw::core::span<const NvSciSyncFence> postFences) = 0;
    };

    class PacketPool
    {
    public:
        SyncWaiter& getSyncWaiter()
        {
            auto* waiter = dynamic_cast<SyncWaiter*>(this);
            if (waiter == nullptr)
            {
                throw Exception(DW_BAD_CAST, "ChannelObject::PacketPool: not a SyncWaiter");
            }
            return *waiter;
        }

        SyncSignaler& getSyncSignaler()
        {
            auto* signaler = dynamic_cast<SyncSignaler*>(this);
            if (signaler == nullptr)
            {
                throw Exception(DW_BAD_CAST, "ChannelObject::PacketPool: not a SyncSignaler");
            }
            return *signaler;
        }

        virtual dwStatus wait(dwTime_t timeout) = 0;
        virtual void setOnDataReady(void* opaque, IChannelPacketFactory::OnDataReady onDataReady) = 0;
    };

    class Producer : public PacketPool
    {
    public:
        virtual dwStatus get(GenericData* data) = 0;
        virtual dwStatus send(void* data) = 0;
    };

    class Consumer : public PacketPool
    {
    public:
        virtual dwStatus recv(GenericData* data) = 0;
        virtual dwStatus release(void* data) = 0;
    };

    virtual Producer* getProducer(GenericDataReference ref) = 0;

    virtual Consumer* getConsumer(GenericDataReference ref) = 0;

    virtual bool hasClients() const = 0;

    virtual bool isConnected() const = 0;

    virtual dwStatus connect(dwTime_t timeout) = 0;

    virtual const ChannelParams& getParams() const = 0;
};

} // namespace framework
} // namespace dw

#endif // DW_FRAMEWORK_CHANNEL_HPP_