service/native/framework_unified/client/include/native_service/nslogutil_cmd_if.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 /// \file
  19 /// Declares COMMANDS related to Log Utility
  20 ///
  21 //////////////////////////////////////////////////////////////////////////////////////////////////
  22
  23 /**
  24  * @file
  25  * @brief \~english Declares COMMANDS related to Log Utility
  26  */
  27 /** @addtogroup BaseSystem
  28  *  @{
  29  */
  30 /** @addtogroup native_service
  31  *  @ingroup BaseSystem
  32  *  @{
  33  */
  34 /** @addtogroup framework_unified
  35  *  @ingroup native_service
  36  *  @{
  37  */
  38 /** @addtogroup utility
  39  *  @ingroup framework_unified
  40  *  @{
  41  */
  42
  43 #ifndef COMMANDS_H_  // NOLINT  (build/header_guard)
  44 #define COMMANDS_H_
  45
  46 // Notifications
  47 #define NTFY_LOGGER_SETCONTROLMASK    "LoggerService/SetControlMask"
  48
  49 ///////////////////////////////////////////////////////////////////////////////
  50 /// \ingroup tag_NSLogger
  51 /// \brief    Logger Utility Commands
  52 ///////////////////////////////////////////////////////////////////////////////
  53 typedef enum _COMMANDS {
  54   SET_LOG_MASK = 0xAEA,     // < Sets the NS log mask for a process. uses CHANGELOGPARAMS
  55   GET_LOG_MASK,         // < Gets the NS log mask for a process. uses CHANGELOGPARAMS
  56   SET_LOG_OUT_OPT,        // < Sets the NS log output option mask for a process. uses CHANGELOGPARAMS
  57   GET_LOG_OUT_OPT,      // < Gets the NS log output option mask for a process. uses CHANGELOGPARAMS
  58   GET_LOG_MASK_RESPONSE,    // < Get the response about NS log masks
  59   GET_LOG_OUT_OPT_RESPONSE,  // < Get the response about NS log output options
  60   SET_MSGTX_RX_ON_AND_TX_OFF,  // < Sets TransmissionLogger to receive ON, transmit OFF
  61   SET_MSGTX_RX_OFF_AND_TX_ON,  // < Sets TransmissionLogger to receive OFF, transmit ON
  62   SET_MSGTX_RX_AND_TX_ON,   // < Sets TransmissionLogger to receive ON, transmit ON
  63   SET_MSGTX_RX_AND_TX_OFF,  // < Sets TransmissionLogger to receive OFF, transmit OFF
  64   kDebugDumpRequest,      // < Sets a debug dump log to the debug dump queue
  65   SET_LOG_SEVERITY,     // < Sets the NS severity log level
  66   GET_LOG_SEVERITY,     // < Gets the NS severity log level
  67   GET_LOG_SEVERITY_RESPONSE,  // < Get the response about NS serverity log level
  68
  69   // list of protocols provided for rcs logger plugin
  70   NSRCS_SET_LOG_SETTINGS_REQ,   // < Set the NS RCS log setting request
  71   NSRCS_SET_LOG_SETTINGS_RESP,  // < Set the NS RCS log setting response
  72   NSRCS_GET_LOG_SETTINGS_REQ,   // < Get the NS RCS log setting request
  73   NSRCS_GET_LOG_SETTINGS_RESP,  // < Get the NS RCS log setting response
  74   NSRCS_SET_LOG_MASK_REQ,     // < Set the NS RCS log mask request
  75   NSRCS_SET_LOG_MASK_RESP,    // < Get the NS RCS log mask response
  76   NSRCS_SET_LOG_OUT_OPT_REQ,    // < Set the NS RCS log output option request
  77   NSRCS_SET_LOG_OUT_OPT_RESP,   // < Set the NS RCS log output option response
  78   NSRCS_SET_LOG_SEVERITY_REQ,   // < Set the NS RCS severity log level request
  79   NSRCS_SET_LOG_SEVERITY_RESP,  // < Set the NS RCS severity log level response
  80 } COMMANDS;
  81
  82 #endif /* COMMANDS_H_ */  // NOLINT  (build/header_guard)
  83 /** @}*/
  84 /** @}*/
  85 /** @}*/
  86 /** @}*/