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 Provides FFRT C APIs. 21 * 22 * @since 12 23 */ 24 25 /** 26 * @file timer.h 27 * 28 * @brief Declares the timer interfaces in C. 29 * 30 * @library libffrt.z.so 31 * @kit FunctionFlowRuntimeKit 32 * @syscap SystemCapability.Resourceschedule.Ffrt.Core 33 * @since 12 34 */ 35 36 #ifndef FFRT_API_C_TIMER_H 37 #define FFRT_API_C_TIMER_H 38 39 #include <stdbool.h> 40 #include "type_def.h" 41 42 /** 43 * @brief Starts a timer on ffrt worker 44 * 45 * @warning Do not call `exit` in `cb` - this my cause unexpected behavior. 46 * 47 * @param qos Indicates qos of the worker that runs timer. 48 * @param timeout Indicates the number of milliseconds that specifies timeout. 49 * @param data Indicates user data used in cb. 50 * @param cb Indicates user cb which will be executed when timeout. 51 * @param repeat Indicates whether to repeat this timer. 52 * @return Returns a timer handle. 53 * @since 12 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 Stops a timer on ffrt worker. 59 * 60 * @note Blocking interface. Avoid using in callbacks to prevent deadlock or synchronization issues. 61 * When the callback corresponding to the provided handle is executing, 62 * this function will wait for the callback to complete before continuing. 63 * 64 * @param qos Indicates qos of the worker that runs timer. 65 * @param handle Indicates the target timer handle. 66 * @return Returns 0 if success; 67 returns -1 otherwise. 68 * @since 12 69 */ 70 FFRT_C_API int ffrt_timer_stop(ffrt_qos_t qos, ffrt_timer_t handle); 71 72 #endif // FFRT_API_C_TIMER_H 73 /** @} */