1 /* 2 * Copyright (C) 2021 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 #ifndef MUTEX_H 17 #define MUTEX_H 18 19 #include <stdint.h> 20 21 #ifdef __cplusplus 22 extern "C" { 23 #endif 24 25 typedef struct Mutex Mutex; 26 27 /** 28 * @brief Initialize the object of the Mutex. 29 * 30 * @return Succeed return Mutex pointer, failed return NULL. 31 * @since 6 32 */ 33 Mutex *MutexCreate(); 34 35 /** 36 * @brief Delete object of the Mutex. 37 * 38 * @param mutex Mutex pointer. 39 * @since 6 40 */ 41 void MutexDelete(Mutex *mutex); 42 43 /** 44 * @brief Lock the Mutex instance. 45 * 46 * @param mutex Mutex pointer. 47 * @since 6 48 */ 49 void MutexLock(Mutex *mutex); 50 51 /** 52 * @brief Unlock the Mutex instance. 53 * 54 * @param mutex Mutex pointer. 55 * @since 6 56 */ 57 void MutexUnlock(Mutex *mutex); 58 59 /** 60 * @brief Trylock the Mutex instance. And return the result immediately. 61 * 62 * @param mutex Mutex pointer. 63 * @return int32_t Succeed return 0, failed return -1. 64 * @since 6 65 */ 66 int32_t MutexTryLock(Mutex *mutex); 67 68 #ifdef __cplusplus 69 } 70 #endif 71 72 #endif // MUTEX_H