ChannelDebug.hpp

Go to the documentation of this file.

 
// This code contains NVIDIA Confidential Information and is disclosed
// under the Mutual Non-Disclosure Agreement.
//
// 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 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. 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 products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2021-2024 NVIDIA Corporation. All rights reserved.
//
// NVIDIA Corporation and its licensors retain all intellectual property and proprietary
// rights in and to this software and related documentation and any modifications thereto.
// Any use, reproduction, disclosure or distribution of this software and related
// documentation without an express license agreement from NVIDIA Corporation is
// strictly prohibited.
//
 
#ifndef DW_FRAMEWORK_CHANNEL_DEBUG_HPP_
#define DW_FRAMEWORK_CHANNEL_DEBUG_HPP_
 
#include <dwcgf/channel/Channel.hpp>
 
namespace dw
{
namespace framework
{
 
// LCOV_EXCL_START not used in production but can't be compiled out yet due to usage in tests
class IChannelDebugConsumer
{
public:
    virtual ~IChannelDebugConsumer()               = default;
    virtual dwStatus wait(dwTime_t timeout)        = 0;
    virtual std::shared_ptr<IChannelPacket> recv() = 0;
    static std::unique_ptr<IChannelDebugConsumer> getFromChannel(
        ChannelObject& channelObject,
        GenericDataReference& ref);
};
 
class IChannelDebugProducer
{
public:
    virtual ~IChannelDebugProducer()              = default;
    virtual dwStatus get(IChannelPacket*& packet) = 0;
    virtual void send(IChannelPacket& packet)     = 0;
    static std::unique_ptr<IChannelDebugProducer> getFromChannel(
        ChannelObject& channelObject,
        GenericDataReference& ref);
};
// LCOV_EXCL_STOP
 
} // namespace framework
} // namespace dw
 
#endif // DW_FRAMEWORK_CHANNEL_DEBUG_HPP_