blob: 616bda409bf33611a00b53dc38e2838bb394c710 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*
* @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
*
* 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.
*/
// libraries for replacing PosixBasedOS001 to Linux
// PosixBasedOS001TimeApi.h
#ifndef OTHERSERVICE_POSIXBASEDOS001LEGACYLIBRARY_POSIXBASEDOS001_TIMEAPI_H_ // NOLINT(build/header_guard)
#define OTHERSERVICE_POSIXBASEDOS001LEGACYLIBRARY_POSIXBASEDOS001_TIMEAPI_H_ // NOLINT(build/header_guard)
#include <sys/types.h>
/*******************************************************************************/
/* define */
/*******************************************************************************/
/* typedef */
/*******************************************************************************/
/* struct */
/*******************************************************************************/
/* function */
#ifdef __cplusplus
extern "C" {
#endif
/**
* @file PosixBasedOS001TimeApi.h
* @brief \~english This file provides delay API to delay for the specified time.
*/
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup other_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup posix_based_os001_legacy_library
* @ingroup other_service
* @{
*/
/////////////////////////////////////////////////////////////////////////////////////
/// \ingroup delay
/// \~english @par Brief
/// Delay for the specified time.
/// \~english @param [in] duration
/// unsigned int - The number of milliseconds for which to suspend the calling thread from execution
/// \~english @retval EOK
/// \~english @par Prerequisite
/// None
/// \~english @par Change of internal state
/// None
/// \~english @par Conditions of processing failure
/// None
/// \~english @par Detail
/// If duration is more than 1000 milliseconds, return immediately.
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////////
unsigned int delay(unsigned int duration); // NOLINT(readability/nolint)
/** @}*/ // end of posix_based_os001_legacy_library
/** @}*/ // end of other_service
/** @}*/ // end of BaseSystem
#ifdef __cplusplus
}
#endif
#endif // OTHERSERVICE_POSIXBASEDOS001LEGACYLIBRARY_POSIXBASEDOS001_TIMEAPI_H_
|
