mirror of
https://gitee.com/openharmony/interface_sdk_c
synced 2024-11-27 00:41:01 +00:00
update interface
Signed-off-by: zhuguoyang <zhuguoyang@h-partners.com>
This commit is contained in:
parent
b2aa5e56df
commit
dfdfc0be3e
96
resourceschedule/ffrt/c/mutex.h
Normal file
96
resourceschedule/ffrt/c/mutex.h
Normal file
@ -0,0 +1,96 @@
|
||||
/*
|
||||
* Copyright (c) 2023 Huawei Device Co., Ltd.
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup Ffrt
|
||||
* @{
|
||||
*
|
||||
* @brief ffrt provides APIs.
|
||||
*
|
||||
*
|
||||
* @syscap SystemCapability.Resourceschedule.Ffrt.Core
|
||||
*
|
||||
* @since 10
|
||||
*/
|
||||
|
||||
/**
|
||||
* @file mutex.h
|
||||
*
|
||||
* @brief Declares the mutex interfaces in C.
|
||||
*
|
||||
* @syscap SystemCapability.Resourceschedule.Ffrt.Core
|
||||
* @since 10
|
||||
* @version 1.0
|
||||
*/
|
||||
#ifndef FFRT_API_C_MUTEX_H
|
||||
#define FFRT_API_C_MUTEX_H
|
||||
#include "type_def.h"
|
||||
|
||||
/**
|
||||
* @brief Initializes a mutex.
|
||||
*
|
||||
* @param mutex Indicates a pointer to the mutex.
|
||||
* @param attr Indicates a pointer to the mutex attribute.
|
||||
* @return Returns <b>ffrt_thrd_success</b> if the mutex is initialized;
|
||||
returns <b>ffrt_thrd_error</b> otherwise.
|
||||
* @since 10
|
||||
* @version 1.0
|
||||
*/
|
||||
FFRT_C_API int ffrt_mutex_init(ffrt_mutex_t* mutex, const ffrt_mutexattr_t* attr);
|
||||
|
||||
/**
|
||||
* @brief Locks a mutex.
|
||||
*
|
||||
* @param mutex Indicates a pointer to the mutex.
|
||||
* @return Returns <b>ffrt_thrd_success</b> if the mutex is locked;
|
||||
returns <b>ffrt_thrd_error</b> or blocks the calling thread otherwise.
|
||||
* @since 10
|
||||
* @version 1.0
|
||||
*/
|
||||
FFRT_C_API int ffrt_mutex_lock(ffrt_mutex_t* mutex);
|
||||
|
||||
/**
|
||||
* @brief Unlocks a mutex.
|
||||
*
|
||||
* @param mutex Indicates a pointer to the mutex.
|
||||
* @return Returns <b>ffrt_thrd_success</b> if the mutex is unlocked;
|
||||
returns <b>ffrt_thrd_error</b> otherwise.
|
||||
* @since 10
|
||||
* @version 1.0
|
||||
*/
|
||||
FFRT_C_API int ffrt_mutex_unlock(ffrt_mutex_t* mutex);
|
||||
|
||||
/**
|
||||
* @brief Attempts to lock a mutex.
|
||||
*
|
||||
* @param mutex Indicates a pointer to the mutex.
|
||||
* @return Returns <b>ffrt_thrd_success</b> if the mutex is locked;
|
||||
returns <b>ffrt_thrd_error</b> or <b>ffrt_thrd_busy</b> otherwise.
|
||||
* @since 10
|
||||
* @version 1.0
|
||||
*/
|
||||
FFRT_C_API int ffrt_mutex_trylock(ffrt_mutex_t* mutex);
|
||||
|
||||
/**
|
||||
* @brief Destroys a mutex.
|
||||
*
|
||||
* @param mutex Indicates a pointer to the mutex.
|
||||
* @return Returns <b>ffrt_thrd_success</b> if the mutex is destroyed;
|
||||
returns <b>ffrt_thrd_error</b> otherwise.
|
||||
* @since 10
|
||||
* @version 1.0
|
||||
*/
|
||||
FFRT_C_API int ffrt_mutex_destroy(ffrt_mutex_t* mutex);
|
||||
#endif
|
Loading…
Reference in New Issue
Block a user