Timer.h

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) 2017-2021 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_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>
#include <dw/core/context/Context.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct dwTimerObject* dwTimerHandle_t;
typedef struct dwTimerObject const* dwConstTimerHandle_t;
typedef void (*dwTimerWork)(void* ptr);

DW_API_PUBLIC
dwStatus dwTimer_initialize(dwTimerHandle_t* timer, const char* timerName,
                            dwContextHandle_t context);

DW_API_PUBLIC
dwStatus dwTimer_release(dwTimerHandle_t timer);

DW_API_PUBLIC
dwStatus dwTimer_cancelSync(dwTimerHandle_t timer);

DW_API_PUBLIC
dwStatus dwTimer_cancelAsync(dwTimerHandle_t timer);

DW_API_PUBLIC
dwStatus dwTimer_scheduleTaskOneShot(const dwTimerWork task, void* clientData,
                                     const dwTime_t startTime, dwTimerHandle_t timer);

DW_API_PUBLIC
dwStatus dwTimer_scheduleTaskRecurring(const dwTimerWork task, void* clientData,
                                       const dwTime_t startTime, const dwTime_t period, dwTimerHandle_t timer);

#ifdef __cplusplus
}
#endif

#endif // DW_CORE_TIMER_H_