blob: c66a836a2c52ed5e82f87acd1494852e0cf1aa0f [file] [log] [blame] [edit]
// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef FLUTTER_RUNTIME_SERVICE_PROTOCOL_H_
#define FLUTTER_RUNTIME_SERVICE_PROTOCOL_H_
#include <map>
#include <set>
#include <string>
#include <string_view>
#include "flutter/fml/compiler_specific.h"
#include "flutter/fml/macros.h"
#include "flutter/fml/synchronization/atomic_object.h"
#include "flutter/fml/synchronization/shared_mutex.h"
#include "flutter/fml/task_runner.h"
#include "rapidjson/document.h"
namespace flutter {
class ServiceProtocol {
public:
static const std::string_view kScreenshotExtensionName;
static const std::string_view kScreenshotSkpExtensionName;
static const std::string_view kRunInViewExtensionName;
static const std::string_view kFlushUIThreadTasksExtensionName;
static const std::string_view kSetAssetBundlePathExtensionName;
static const std::string_view kGetDisplayRefreshRateExtensionName;
static const std::string_view kGetSkSLsExtensionName;
class Handler {
public:
struct Description {
int64_t isolate_port = 0 /* illegal port by default. */;
std::string isolate_name;
Description() {}
Description(int64_t p_isolate_port, std::string p_isolate_name)
: isolate_port(p_isolate_port),
isolate_name(std::move(p_isolate_name)) {}
void Write(Handler* handler,
rapidjson::Value& value,
rapidjson::MemoryPoolAllocator<>& allocator) const;
};
using ServiceProtocolMap = std::map<std::string_view, std::string_view>;
virtual fml::RefPtr<fml::TaskRunner> GetServiceProtocolHandlerTaskRunner(
std::string_view method) const = 0;
virtual Description GetServiceProtocolDescription() const = 0;
virtual bool HandleServiceProtocolMessage(
std::string_view method, // one if the extension names specified above.
const ServiceProtocolMap& params,
rapidjson::Document& response) = 0;
};
ServiceProtocol();
~ServiceProtocol();
void ToggleHooks(bool set);
void AddHandler(Handler* handler, Handler::Description description);
void RemoveHandler(Handler* handler);
void SetHandlerDescription(Handler* handler,
Handler::Description description);
private:
const std::set<std::string_view> endpoints_;
std::unique_ptr<fml::SharedMutex> handlers_mutex_;
std::map<Handler*, fml::AtomicObject<Handler::Description>> handlers_;
[[nodiscard]] static bool HandleMessage(const char* method,
const char** param_keys,
const char** param_values,
intptr_t num_params,
void* user_data,
const char** json_object);
[[nodiscard]] static bool HandleMessage(
std::string_view method,
const Handler::ServiceProtocolMap& params,
ServiceProtocol* service_protocol,
rapidjson::Document& response);
[[nodiscard]] bool HandleMessage(std::string_view method,
const Handler::ServiceProtocolMap& params,
rapidjson::Document& response) const;
[[nodiscard]] bool HandleListViewsMethod(rapidjson::Document& response) const;
FML_DISALLOW_COPY_AND_ASSIGN(ServiceProtocol);
};
} // namespace flutter
#endif // FLUTTER_RUNTIME_SERVICE_PROTOCOL_H_