ILockstepSyncClient.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) 2022-2023 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_ILOCKSTEP_SYNC_CLIENT_HPP_
#define DW_FRAMEWORK_ILOCKSTEP_SYNC_CLIENT_HPP_
 
#include <dw/core/base/Types.h>
 
namespace dw
{
namespace framework
{
namespace lockstep
{
 
enum class LockstepSyncDataStatus
{
    DATA_NOT_READY,
    DATA_CONSUME,
    DATA_DROP
};
 
enum class LookstepSyncMessageType
{
    LOCKSTEP_SYNC_ADVANCE_PKT,
    LOCKSTEP_SYNC_DATA_HEADER,
    LOCKSTEP_SYNC_UNBLOCK
};
 
struct LockstepSyncHeader
{
    LookstepSyncMessageType type;
    dwTime_t timestamp;
    uint64_t seqNum;
};
 
class ILockstepSyncClientProducer
{
public:
    virtual void sendDataHeader(const LockstepSyncHeader& header) = 0;
};
 
class ILockstepSyncClientConsumer
{
public:
    virtual bool postProcessData(LockstepSyncDataStatus& result, const LockstepSyncHeader& header) = 0;
};
 
// coverity[autosar_cpp14_a0_1_6_violation]
class ILockstepSyncClient
{
public:
    virtual bool wait() = 0;
 
    virtual void setIterationCount(uint32_t iterationCount) = 0;
 
    virtual void sendNextTimestamp() = 0;
 
    virtual void sendTeardownMessage() = 0;
 
    virtual ILockstepSyncClientProducer& getProducer() = 0;
 
    virtual ILockstepSyncClientConsumer& getConsumer() = 0;
 
    virtual dwTime_t getTimeoutUs() const = 0;
 
    virtual ~ILockstepSyncClient() = default;
};
 
} // namespace lockstep
} // namespace framework
} // namespace dw
 
#endif // DW_FRAMEWORK_ILOCKSTEP_SYNC_CLIENT_HPP_