1 /* 2 * Copyright (c) 2023 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 /** 17 * @addtogroup Ffrt 18 * @{ 19 * 20 * @brief ffrt provides APIs. 21 * 22 * 23 * @syscap SystemCapability.Resourceschedule.Ffrt.Core 24 * 25 * @since 12 26 */ 27 28 /** 29 * @file timer.h 30 * 31 * @brief Declares the timer interfaces in C. 32 * 33 * @syscap SystemCapability.Resourceschedule.Ffrt.Core 34 * @since 12 35 * @version 1.0 36 */ 37 #ifndef FFRT_API_C_TIMER_H 38 #define FFRT_API_C_TIMER_H 39 #include <stdbool.h> 40 41 #include "type_def.h" 42 43 /** 44 * @brief Start a timer on ffrt worker 45 * 46 * @param qos Indicates qos of the worker that runs timer. 47 * @param timeout Indicates the number of milliseconds that specifies timeout. 48 * @param data Indicates user data used in cb. 49 * @param cb Indicates user cb which will be executed when timeout. 50 * @param repeat Indicates whether to repeat this timer. 51 * @return Returns a timer handle. 52 * @since 12 53 * @version 1.0 54 */ 55 FFRT_C_API ffrt_timer_t ffrt_timer_start(ffrt_qos_t qos, uint64_t timeout, void* data, ffrt_timer_cb cb, bool repeat); 56 57 /** 58 * @brief Stop a target timer on ffrt worker 59 * 60 * @param qos Indicates qos of the worker that runs timer. 61 * @param handle Indicates the target timer handle. 62 * @return Returns 0 if success; 63 returns -1 otherwise. 64 * @since 12 65 * @version 1.0 66 */ 67 FFRT_C_API int ffrt_timer_stop(ffrt_qos_t qos, ffrt_timer_t handle); 68 #endif