flutter_runner::Engine Class Reference

#include <engine.h>

Inheritance diagram for flutter_runner::Engine:

Classes
class	Delegate

Public Member Functions
	Engine (Delegate &delegate, std::string thread_label, std::shared_ptr< sys::ServiceDirectory > svc, std::shared_ptr< sys::ServiceDirectory > runner_services, flutter::Settings settings, fuchsia::ui::views::ViewCreationToken view_creation_token, std::pair< fuchsia::ui::views::ViewRefControl, fuchsia::ui::views::ViewRef > view_ref_pair, UniqueFDIONS fdio_ns, fidl::InterfaceRequest< fuchsia::io::Directory > directory_request, FlutterRunnerProductConfiguration product_config, const std::vector< std::string > &dart_entrypoint_args)
	~Engine ()
std::optional< uint32_t >	GetEngineReturnCode () const
void	WriteProfileToTrace () const

Static Public Member Functions
static flutter::ThreadHost	CreateThreadHost (const std::string &name_prefix, const std::shared_ptr< sys::ServiceDirectory > &runner_services=nullptr)

Friends
class	testing::EngineTest

Detailed Description

Definition at line 39 of file engine.h.

Constructor & Destructor Documentation

Engine()

flutter_runner::Engine::Engine	(	Delegate &	delegate,
		std::string	thread_label,
		std::shared_ptr< sys::ServiceDirectory >	svc,
		std::shared_ptr< sys::ServiceDirectory >	runner_services,
		flutter::Settings	settings,
		fuchsia::ui::views::ViewCreationToken	view_creation_token,
		std::pair< fuchsia::ui::views::ViewRefControl, fuchsia::ui::views::ViewRef >	view_ref_pair,
		UniqueFDIONS	fdio_ns,
		fidl::InterfaceRequest< fuchsia::io::Directory >	directory_request,
		FlutterRunnerProductConfiguration	product_config,
		const std::vector< std::string > &	dart_entrypoint_args
	)

Definition at line 203 of file engine.cc.

    : delegate_(delegate),
      thread_label_(std::move(thread_label)),
      thread_host_(CreateThreadHost(thread_label_, runner_services)),
      view_creation_token_(std::move(view_creation_token)),
      memory_pressure_watcher_binding_(this),
      latest_memory_pressure_level_(fuchsia::memorypressure::Level::NORMAL),
      intercept_all_input_(product_config.get_intercept_all_input()),
      weak_factory_(this) {
  Initialize(std::move(view_ref_pair), std::move(svc),
             std::move(runner_services), std::move(settings),
             std::move(fdio_ns), std::move(directory_request),
             std::move(product_config), dart_entrypoint_args);
}

~Engine()

flutter_runner::Engine::~Engine

(

)

Definition at line 698 of file engine.cc.

                {
  shell_.reset();
 
  // Destroy rendering objects on the raster thread.
  fml::AutoResetWaitableEvent view_embedder_latch;
  thread_host_.raster_thread->GetTaskRunner()->PostTask(
      fml::MakeCopyable([this, &view_embedder_latch]() mutable {
        view_embedder_.reset();
        flatland_connection_.reset();
        surface_producer_.reset();
        view_embedder_latch.Signal();
      }));
  view_embedder_latch.Wait();
}

References fml::MakeCopyable(), fml::AutoResetWaitableEvent::Signal(), thread_host_, and fml::AutoResetWaitableEvent::Wait().

Member Function Documentation

CreateThreadHost()

flutter::ThreadHost flutter_runner::Engine::CreateThreadHost ( const std::string &  name_prefix, const std::shared_ptr< sys::ServiceDirectory > &  runner_services = nullptr  )

static

Definition at line 137 of file engine.cc.

                                                        {
  fml::Thread::SetCurrentThreadName(
      fml::Thread::ThreadConfig(name_prefix + ".platform"));
 
  // Default the config setter to setup the thread name only.
  flutter::ThreadConfigSetter config_setter = fml::Thread::SetCurrentThreadName;
 
  // Override the config setter if the media profile provider is available.
  if (services) {
    // Connect to the media profile provider to assign thread priorities using
    // Fuchsia's scheduler role API. Failure to connect will print a warning and
    // proceed with engine initialization, leaving threads created by the engine
    // at default priority.
    //
    // The use of std::shared_ptr here is to work around the unfortunate
    // requirement for flutter::ThreadConfigSetter (i.e. std::function<>) that
    // the target callable be copy-constructible. This awkwardly conflicts with
    // fuchsia::media::ProfileProviderSyncPtr being move-only. std::shared_ptr
    // provides copyable object that references the move-only SyncPtr.
    std::shared_ptr<fuchsia::media::ProfileProviderSyncPtr>
        media_profile_provider =
            std::make_shared<fuchsia::media::ProfileProviderSyncPtr>();
 
    const zx_status_t connect_status =
        services->Connect(media_profile_provider->NewRequest());
    if (connect_status != ZX_OK) {
      FML_LOG(WARNING)
          << "Failed to connect to " << fuchsia::media::ProfileProvider::Name_
          << ": " << zx_status_get_string(connect_status)
          << " This is not a fatal error, but threads created by the engine "
             "will run at default priority, regardless of the requested "
             "priority.";
    } else {
      // Set the role for (this) platform thread. See comment above about the
      // role naming scheme.
      SetThreadRole(*media_profile_provider, name_prefix + ".type.platform");
 
      // This lambda must be copyable or the assignment fails to compile,
      // necessitating the use of std::shared_ptr for the profile provider.
      config_setter = [name_prefix, media_profile_provider](
                          const fml::Thread::ThreadConfig& config) {
        SetThreadConfig(name_prefix, *media_profile_provider, config);
      };
    }
  }
 
  flutter::ThreadHost::ThreadHostConfig thread_host_config{config_setter};
 
  thread_host_config.SetRasterConfig(
      {flutter::ThreadHost::ThreadHostConfig::MakeThreadName(
           flutter::ThreadHost::Type::kRaster, name_prefix),
       fml::Thread::ThreadPriority::kRaster});
  thread_host_config.SetUIConfig(
      {flutter::ThreadHost::ThreadHostConfig::MakeThreadName(
           flutter::ThreadHost::Type::kUi, name_prefix),
       fml::Thread::ThreadPriority::kDisplay});
  thread_host_config.SetIOConfig(
      {flutter::ThreadHost::ThreadHostConfig::MakeThreadName(
           flutter::ThreadHost::Type::kIo, name_prefix),
       fml::Thread::ThreadPriority::kNormal});
 
  return flutter::ThreadHost(thread_host_config);
}

References FML_LOG, fml::Thread::kDisplay, flutter::ThreadHost::kIo, fml::Thread::kNormal, fml::Thread::kRaster, flutter::ThreadHost::kRaster, flutter::ThreadHost::kUi, flutter::ThreadHost::ThreadHostConfig::MakeThreadName(), fml::Thread::SetCurrentThreadName(), and flutter::ThreadHost::ThreadHostConfig::SetRasterConfig().

Referenced by flutter_runner::testing::TEST().

GetEngineReturnCode()

std::optional< uint32_t > flutter_runner::Engine::GetEngineReturnCode

(

)

const

Definition at line 713 of file engine.cc.

                                                        {
  if (!shell_) {
    return std::nullopt;
  }
  std::optional<uint32_t> code;
  fml::AutoResetWaitableEvent latch;
  fml::TaskRunner::RunNowOrPostTask(
      shell_->GetTaskRunners().GetUITaskRunner(),
      [&latch, &code, engine = shell_->GetEngine()]() {
        if (engine) {
          code = engine->GetUIIsolateReturnCode();
        }
        latch.Signal();
      });
  latch.Wait();
  return code;
}

References engine, fml::TaskRunner::RunNowOrPostTask(), and fml::AutoResetWaitableEvent::Signal().

WriteProfileToTrace()

void flutter_runner::Engine::WriteProfileToTrace

(

)

const

Definition at line 811 of file engine.cc.

                                       {
  Dart_Port main_port = shell_->GetEngine()->GetUIIsolateMainPort();
  char* error = NULL;
  bool success = Dart_WriteProfileToTimeline(main_port, &error);
  if (!success) {
    FML_LOG(ERROR) << "Failed to write Dart profile to trace: " << error;
    free(error);
  }
}

References error, and FML_LOG.

Friends And Related Symbol Documentation

testing::EngineTest

friend class testing::EngineTest

friend

Definition at line 149 of file engine.h.

---

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

• shell/platform/fuchsia/flutter/engine.h
• shell/platform/fuchsia/flutter/engine.cc