flutter::ServiceProtocol Class Reference

#include <service_protocol.h>

Classes
class	Handler

Public Member Functions
	ServiceProtocol ()
	~ServiceProtocol ()
void	ToggleHooks (bool set)
void	AddHandler (Handler *handler, const Handler::Description &description)
void	RemoveHandler (Handler *handler)
void	SetHandlerDescription (Handler *handler, const Handler::Description &description)

Static Public Attributes
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
static const std::string_view	kEstimateRasterCacheMemoryExtensionName
static const std::string_view	kRenderFrameWithRasterStatsExtensionName
static const std::string_view	kReloadAssetFonts

Detailed Description

Definition at line 22 of file service_protocol.h.

Constructor & Destructor Documentation

ServiceProtocol()

flutter::ServiceProtocol::ServiceProtocol

(

)

Definition at line 50 of file service_protocol.cc.

    : endpoints_({
          // Private
          kListViewsExtensionName,
 
          // Public
          kScreenshotExtensionName,
          kScreenshotSkpExtensionName,
          kRunInViewExtensionName,
          kFlushUIThreadTasksExtensionName,
          kSetAssetBundlePathExtensionName,
          kGetDisplayRefreshRateExtensionName,
          kGetSkSLsExtensionName,
          kEstimateRasterCacheMemoryExtensionName,
          kRenderFrameWithRasterStatsExtensionName,
          kReloadAssetFonts,
      }),
      handlers_mutex_(fml::SharedMutex::Create()) {}

~ServiceProtocol()

flutter::ServiceProtocol::~ServiceProtocol

(

)

Definition at line 69 of file service_protocol.cc.

                                  {
  ToggleHooks(false);
}

Member Function Documentation

AddHandler()

void flutter::ServiceProtocol::AddHandler	(	Handler *	handler,
		const Handler::Description &	description
	)

Definition at line 73 of file service_protocol.cc.

                                                                        {
  fml::UniqueLock lock(*handlers_mutex_);
  handlers_.emplace(handler, description);
}

RemoveHandler()

void flutter::ServiceProtocol::RemoveHandler

(

Handler *

handler

)

Definition at line 79 of file service_protocol.cc.

                                                    {
  fml::UniqueLock lock(*handlers_mutex_);
  handlers_.erase(handler);
}

SetHandlerDescription()

void flutter::ServiceProtocol::SetHandlerDescription	(	Handler *	handler,
		const Handler::Description &	description
	)

Definition at line 84 of file service_protocol.cc.

                                           {
  fml::SharedLock lock(*handlers_mutex_);
  auto it = handlers_.find(handler);
  if (it != handlers_.end()) {
    it->second.Store(description);
  }
}

ToggleHooks()

void flutter::ServiceProtocol::ToggleHooks

(

bool

set

)

Definition at line 94 of file service_protocol.cc.

                                          {
  for (const auto& endpoint : endpoints_) {
    Dart_RegisterIsolateServiceRequestCallback(
        endpoint.data(),                  // method
        &ServiceProtocol::HandleMessage,  // callback
        set ? this : nullptr              // user data
    );
  }
}

Member Data Documentation

kEstimateRasterCacheMemoryExtensionName

const std::string_view flutter::ServiceProtocol::kEstimateRasterCacheMemoryExtensionName

static

Initial value:

=
        "_flutter.estimateRasterCacheMemory"

Definition at line 31 of file service_protocol.h.

kFlushUIThreadTasksExtensionName

const std::string_view flutter::ServiceProtocol::kFlushUIThreadTasksExtensionName

static

Initial value:

=
    "_flutter.flushUIThreadTasks"

Definition at line 27 of file service_protocol.h.

kGetDisplayRefreshRateExtensionName

const std::string_view flutter::ServiceProtocol::kGetDisplayRefreshRateExtensionName

static

Initial value:

=
    "_flutter.getDisplayRefreshRate"

Definition at line 29 of file service_protocol.h.

kGetSkSLsExtensionName

const std::string_view flutter::ServiceProtocol::kGetSkSLsExtensionName

static

Initial value:

=
    "_flutter.getSkSLs"

Definition at line 30 of file service_protocol.h.

kReloadAssetFonts

const std::string_view flutter::ServiceProtocol::kReloadAssetFonts

static

Initial value:

=
    "_flutter.reloadAssetFonts"

Definition at line 33 of file service_protocol.h.

kRenderFrameWithRasterStatsExtensionName

const std::string_view flutter::ServiceProtocol::kRenderFrameWithRasterStatsExtensionName

static

Initial value:

=
        "_flutter.renderFrameWithRasterStats"

Definition at line 32 of file service_protocol.h.

kRunInViewExtensionName

const std::string_view flutter::ServiceProtocol::kRunInViewExtensionName

static

Initial value:

=
    "_flutter.runInView"

Definition at line 26 of file service_protocol.h.

kScreenshotExtensionName

const std::string_view flutter::ServiceProtocol::kScreenshotExtensionName

static

Initial value:

=
    "_flutter.screenshot"

Definition at line 24 of file service_protocol.h.

kScreenshotSkpExtensionName

const std::string_view flutter::ServiceProtocol::kScreenshotSkpExtensionName

static

Initial value:

=
    "_flutter.screenshotSkp"

Definition at line 25 of file service_protocol.h.

kSetAssetBundlePathExtensionName

const std::string_view flutter::ServiceProtocol::kSetAssetBundlePathExtensionName

static

Initial value:

=
    "_flutter.setAssetBundlePath"

Definition at line 28 of file service_protocol.h.

---

The documentation for this class was generated from the following files:

• runtime/service_protocol.h
• runtime/service_protocol.cc