nsframework/framework_unified/client/include/native_service/ns_system_mode.h

   1 /*
   2  * @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*
  18  * NS_SYSTEM_MODE.h
  19  */
  20
  21 ///////////////////////////////////////////////////////////////////////////////
  22 /// \ingroup  tag_NSFramework
  23 ///////////////////////////////////////////////////////////////////////////////
  24 //@{
  25 /**
  26  * @file ns_system_mode.h
  27  * @brief \~english The file defines enum SystemModeProtocol
  28  *
  29  */
  30 /** @addtogroup BaseSystem
  31  *  @{
  32  */
  33 /** @addtogroup native_service
  34  *  @ingroup BaseSystem
  35  *  @{
  36  */
  37 /** @addtogroup framework_unified
  38  *  @ingroup native_service
  39  *  @{
  40  */
  41 /** @addtogroup native
  42  *  @ingroup framework_unified
  43  *  @{
  44  */
  45 #ifndef __NATIVESERVICES_SYSTEM_MODE_H__  // NOLINT  (build/header_guard)
  46 #define __NATIVESERVICES_SYSTEM_MODE_H__
  47
  48 #include <native_service/frameworkunified_types.h>
  49 #include <native_service/frameworkunified_service_protocol.h>
  50
  51 ////////////////////////////////////////////////////////////////////////////////////////////////
  52 /// \ingroup  tag_System
  53 /// \brief    System Mode Protocol
  54 ////////////////////////////////////////////////////////////////////////////////////////////////
  55 typedef enum _SystemModeProtocol {
  56   SYSTEM_ON_INITIALIZATION = PROTOCOL_THREAD_INITIALIZATION,  ///< Initialize thread after creation
  57   SYSTEM_ON_WAKEUP         = PROTOCOL_THREAD_WAKEUP,     ///< Wakeup Thread after sleep
  58   SYSTEM_ON_SHUTDOWN       = PROTOCOL_THREAD_SHUTDOWN,   ///< Stop the thread
  59   SYSTEM_ON_DESTROY        = PROTOCOL_THREAD_DESTROY  ///< Destroy the thread
  60 } SystemModeProtocol;
  61
  62 #endif /* __NATIVESERVICES_SYSTEM_MODE_H__ */  // NOLINT  (build/header_guard)
  63 /** @}*/
  64 /** @}*/
  65 /** @}*/
  66 /** @}*/
  67 //@}