Timer.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2017-2024 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
 
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
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_