summaryrefslogtreecommitdiffstats
path: root/nsframework/framework_unified/client/include/native_service/ns_system_mode.h
blob: 9815904c906b92374f6276b69a0b263f936f7032 (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
/*
 * @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.
 */

/*
 * NS_SYSTEM_MODE.h
 */

///////////////////////////////////////////////////////////////////////////////
/// \ingroup  tag_NSFramework
///////////////////////////////////////////////////////////////////////////////
//@{
/**
 * @file ns_system_mode.h
 * @brief \~english The file defines enum SystemModeProtocol
 *
 */
/** @addtogroup BaseSystem
 *  @{
 */
/** @addtogroup native_service
 *  @ingroup BaseSystem
 *  @{
 */
/** @addtogroup framework_unified
 *  @ingroup native_service
 *  @{
 */
/** @addtogroup native
 *  @ingroup framework_unified
 *  @{
 */
#ifndef __NATIVESERVICES_SYSTEM_MODE_H__  // NOLINT  (build/header_guard)
#define __NATIVESERVICES_SYSTEM_MODE_H__

#include <native_service/frameworkunified_types.h>
#include <native_service/frameworkunified_service_protocol.h>

////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup  tag_System
/// \brief    System Mode Protocol
////////////////////////////////////////////////////////////////////////////////////////////////
typedef enum _SystemModeProtocol {
  SYSTEM_ON_INITIALIZATION = PROTOCOL_THREAD_INITIALIZATION,  ///< Initialize thread after creation
  SYSTEM_ON_WAKEUP         = PROTOCOL_THREAD_WAKEUP,     ///< Wakeup Thread after sleep
  SYSTEM_ON_SHUTDOWN       = PROTOCOL_THREAD_SHUTDOWN,   ///< Stop the thread
  SYSTEM_ON_DESTROY        = PROTOCOL_THREAD_DESTROY  ///< Destroy the thread
} SystemModeProtocol;

#endif /* __NATIVESERVICES_SYSTEM_MODE_H__ */  // NOLINT  (build/header_guard)
/** @}*/
/** @}*/
/** @}*/
/** @}*/
//@}