video_in_hal/systemservice/interface_unified/library/include/system_service/ss_heartbeat_service_protocol.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 /// Handle HeartBeat Module Start and Stop notifications.
  19 //////////////////////////////////////////////////////////////////////////////////////////////////
  20
  21 /**
  22  * @file ss_heartbeat_service_protocol.h
  23  * @brief  API Header for HeartBeat messages used by senders and receivers.
  24  *
  25  * Declares the external Protocol messages to the HeartBeat.
  26  */
  27
  28 /** @addtogroup BaseSystem
  29  *  @{
  30  */
  31 /** @addtogroup system_service
  32  *  @ingroup BaseSystem
  33  *  @{
  34  */
  35 /** @addtogroup system_manager
  36  *  @ingroup system_service
  37  *  @{
  38  */
  39
  40 #ifndef SS_HEARTBEAT_SERVICE_PROTOCOL_H_  // NOLINT (build/header_guard)
  41 #define SS_HEARTBEAT_SERVICE_PROTOCOL_H_
  42
  43 #include <native_service/frameworkunified_types.h>
  44 #include <native_service/frameworkunified_service_protocol.h>
  45
  46
  47 /// \brief HeatBeat Protocol Command
  48 /// heartbeat service protocol --> define all protocol messages in and out of heart beat thread
  49 /// that are pertinent to the functionality offered by heart beat thread.
  50 typedef enum T_SMHBProtocolMessages {
  51   // Diagnostic Protocol
  52   SS_HEARTBEAT_PRINT_CONNECTIONS           = 0x32,  ///< client to hb thread
  53   SS_HEARTBEAT_PRINT_STACK                 = 0x33,  ///< client to hb thread
  54   SS_HEARTBEAT_PERIODIC_STATUS_REQ         = 0xD0,  ///< sysmgr to hb thread
  55   SS_HEARTBEAT_PERIODIC_RESP               = 0xD1,  ///< hb thread to sysmgr
  56   SS_HEARTBEAT_START                       = 0xD2,  ///< sysmgr to hb thread
  57   SS_HEARTBEAT_STOP                        = 0xD3,  ///< sysmgr to hb thread
  58   SS_HEARTBEAT_DELETE_MODULE_ENTRY         = 0xD5,  ///< sysmgr to hb thread
  59   SS_HEARTBEAT_MSG_CATEGORY_REPORT         = 0xD6,  ///< report message
  60   SS_HEARTBEAT_ERROR_DETECTED              = 0xD8,  ///< hb thread to sysmgr
  61   SS_HEARTBEAT_APPEND_MODULE_ENTRY         = 0xD9,  ///< sysmgr to hb thread
  62   SS_HEARTBEAT_AVAIL_CHECK_REQ             = 0xDA,  ///< sysmgr to hb thread
  63   SS_HEARTBEAT_AVAIL_CHECK_RESP            = 0xDB,  ///< sysmgr to hb thread
  64   SS_HEARTBEAT_RESPONSE                    = 0xE0,  ///< client to hb thread
  65   SS_HEARTBEAT_REQUEST                     = 0xE1   ///< hb thread to client
  66 }EHBProtocolMessages;
  67
  68 #endif /* SS_HEARTBEAT_SERVICE_PROTOCOL_H_ */  // NOLINT (build/header_guard)
  69
  70 /** @}*/
  71 /** @}*/
  72 /** @}*/