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 10
26  */
27 
28 /**
29  * @file sleep.h
30  *
31  * @brief Declares the sleep and yield interfaces in C.
32  *
33  * @syscap SystemCapability.Resourceschedule.Ffrt.Core
34  * @since 10
35  * @version 1.0
36  */
37 #ifndef FFRT_API_C_SLEEP_H
38 #define FFRT_API_C_SLEEP_H
39 #include <stdint.h>
40 #include "type_def.h"
41 
42 /**
43  * @brief Suspends the calling thread for a given duration.
44  *
45  * @param usec Indicates the duration that the calling thread is suspended, in microseconds.
46  * @return Returns <b>ffrt_thrd_success</b> if the thread is suspended;
47            returns <b>ffrt_thrd_error</b> otherwise.
48  * @since 10
49  * @version 1.0
50  */
51 FFRT_C_API int ffrt_usleep(uint64_t usec);
52 
53 /**
54  * @brief Passes control to other tasks so that they can be executed.
55  *
56  * @since 10
57  * @version 1.0
58  */
59 FFRT_C_API void ffrt_yield(void);
60 #endif
61