xref: /aosp_15_r20/external/ot-br-posix/src/utils/system_utils.hpp (revision 4a64e381480ef79f0532b2421e44e6ee336b8e0d)
1 /*
2  *  Copyright (c) 2020, The OpenThread Authors.
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *  1. Redistributions of source code must retain the above copyright
8  *     notice, this list of conditions and the following disclaimer.
9  *  2. Redistributions in binary form must reproduce the above copyright
10  *     notice, this list of conditions and the following disclaimer in the
11  *     documentation and/or other materials provided with the distribution.
12  *  3. Neither the name of the copyright holder nor the
13  *     names of its contributors may be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  *  POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /**
30  * @file
31  *   This file includes definitions for POSIX system utilities.
32  */
33 
34 #ifndef OTBR_UTILS_SYSTEM_UTILS_HPP_
35 #define OTBR_UTILS_SYSTEM_UTILS_HPP_
36 
37 #include "openthread-br/config.h"
38 
39 namespace otbr {
40 namespace SystemUtils {
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 /**
47  * This method formats a system command to execute.
48  *
49  * @param[in] aFormat  A pointer to the format string.
50  * @param[in] ...      Arguments for the format specification.
51  *
52  * @returns The command exit code.
53  */
54 int ExecuteCommand(const char *aFormat, ...);
55 
56 #ifdef __cplusplus
57 }
58 #endif
59 
60 } // namespace SystemUtils
61 } // namespace otbr
62 
63 #endif // OTBR_UTILS_SYSTEM_UTILS_HPP_
64