#include <plugin_manager.h>

apollo::dreamview::PluginManager 的协作图:

Public 类型
using	DvApi = bool(PluginManager::*)(const DvPluginMsg &msg, const std::string &json_str)

using	DvCallback = std::function< bool(const std::string &function_name, const nlohmann::json &param_json)>

Public 成员函数
	PluginManager (WebSocketHandler *plugin_ws)

void	Start (DvCallback callback_api)

void	Stop ()

bool	IsEnabled () const

bool	SendMsgToPlugin (const std::string &json_str)

详细描述

在文件 plugin_manager.h 第 47 行定义.

成员类型定义说明

◆ DvApi

using apollo::dreamview::PluginManager::DvApi = bool (PluginManager::*)(const DvPluginMsg& msg, const std::string& json_str)

在文件 plugin_manager.h 第 55 行定义.

◆ DvCallback

using apollo::dreamview::PluginManager::DvCallback = std::function<bool(const std::string& function_name, const nlohmann::json& param_json)>

在文件 plugin_manager.h 第 57 行定义.

构造及析构函数说明

◆ PluginManager()

PluginManager::PluginManager ( WebSocketHandler * plugin_ws )

explicit

在文件 plugin_manager.cc 第 60 行定义.

    : node_(cyber::CreateNode("PluginManager")),
      enabled_(false),
      plugin_ws_(plugin_ws) {
  RegisterDvSupportApis();
  RegisterPlugins();
}

成员函数说明

◆ IsEnabled()

bool apollo::dreamview::PluginManager::IsEnabled ( ) const

inline

在文件 plugin_manager.h 第 65 行定义.

65{ return true; }

◆ SendMsgToPlugin()

bool PluginManager::SendMsgToPlugin ( const std::string & json_str )

在文件 plugin_manager.cc 第 293 行定义.

                                                          {
  auto plugin_msg = std::make_shared<DvPluginMsg>();
  if (!JsonStringToMessage(json_str, plugin_msg.get()).ok()) {
    AERROR << "Failed to parse DvPluginMsg from json!";
    return false;
  }
  // Cancel check requestId for dv_plus does not have this field
  if (!plugin_msg->has_target() || !plugin_msg->has_name()) {
    AERROR << "Missing required field for DvPluginMsg.";
    return false;
  }
  const string plugin_name = plugin_msg->target();
  if (!CheckPluginStatus(plugin_name)) {
    return false;
  }
  const string msg_name = plugin_msg->name();
 
  if (plugins_[plugin_name].plugin_accept_msg.find(msg_name) ==
      plugins_[plugin_name].plugin_accept_msg.end()) {
    AERROR << "Plugin not accept this msg!";
    return false;
  }
  const string channel_location =
      plugins_[plugin_name].plugin_accept_msg[msg_name];
  if (plugins_[plugin_name].writers.find(channel_location) ==
      plugins_[plugin_name].writers.end()) {
    AERROR << "The plugin does not support communication on this channel";
    return false;
  }
  FillHeader("PluginManager", plugin_msg.get());
  plugins_[plugin_name].writers[channel_location]->Write(plugin_msg);
  return true;
}

◆ Start()

void PluginManager::Start ( DvCallback callback_api )

在文件 plugin_manager.cc 第 68 行定义.

                                                 {
  callback_api_ = callback_api;
  enabled_ = true;
  return;
}

◆ Stop()

void PluginManager::Stop ( )

在文件 plugin_manager.cc 第 74 行定义.

                         {
  if (enabled_) {
    std::string stop_command;
    for (auto iter = plugins_.begin(); iter != plugins_.end(); iter++) {
      stop_command = iter->second.stop_command;
      const int ret = std::system(stop_command.data());
      if (ret != 0) {
        AERROR << "Failed to stop plugin! ret: " << ret;
      }
    }
    plugins_.clear();
    // need kill all plugin process
  }
  enabled_ = false;
}

该类的文档由以下文件生成:

modules/dreamview/backend/common/plugins/plugin_manager.h
modules/dreamview/backend/common/plugins/plugin_manager.cc

Public 类型

Public 成员函数