Timer.h

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) 2017-2022 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_CORE_TIMER_H_
#define DW_CORE_TIMER_H_
 
#include <dw/core/base/Exports.h>
#include <dw/core/base/Types.h>
#include <dw/core/base/Status.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Forward declaration of dwContextHandle_t to not have circular dependency
// @note: The API using the dwContextHandle_t is deprecated and will be removed with next major release
// coverity[misra_c_2012_rule_1_1_violation]
typedef struct dwContextObject* dwContextHandle_t;
 
typedef struct dwTimeSourceObject* dwTimeSourceHandle_t;
typedef struct dwTimeSourceObject const* dwConstTimeSourceHandle_t;
 
typedef struct dwTimerObject* dwTimerHandle_t;
typedef struct dwTimerObject const* dwConstTimerHandle_t;
typedef void (*dwTimerWork)(void* ptr);
 
DW_API_PUBLIC
DW_DEPRECATED("This method is replaced by dwTimer_initializeFromSource() which require a dwTimeSourceHandle_t which can be retrieved from dwContext")
dwStatus dwTimer_initialize(dwTimerHandle_t* const timer, char8_t const* const timerName,
                            dwContextHandle_t const context);
 
DW_API_PUBLIC
dwStatus dwTimer_initializeFromSource(dwTimerHandle_t* const timer, char8_t const* const timerName,
                                      dwTimeSourceHandle_t const source);
 
DW_API_PUBLIC
dwStatus dwTimer_release(dwTimerHandle_t const timer);
 
DW_API_PUBLIC
dwStatus dwTimer_cancelSync(dwTimerHandle_t const timer);
 
DW_API_PUBLIC
dwStatus dwTimer_cancelAsync(dwTimerHandle_t const timer);
 
DW_API_PUBLIC
dwStatus dwTimer_scheduleTaskOneShot(dwTimerWork const task, void* const clientData,
                                     dwTime_t const startTime, dwTimerHandle_t const timer);
 
DW_API_PUBLIC
dwStatus dwTimer_scheduleTaskRecurring(dwTimerWork const task, void* const clientData,
                                       dwTime_t const startTime, dwTime_t const period, dwTimerHandle_t const timer);
 
#ifdef __cplusplus
}
#endif
 
#endif // DW_CORE_TIMER_H_