flutter::EmbedderEngine Class Reference

#include <embedder_engine.h>

Public Member Functions
	EmbedderEngine (std::unique_ptr< EmbedderThreadHost > thread_host, const TaskRunners &task_runners, const Settings &settings, RunConfiguration run_configuration, const Shell::CreateCallback< PlatformView > &on_create_platform_view, const Shell::CreateCallback< Rasterizer > &on_create_rasterizer, std::unique_ptr< EmbedderExternalTextureResolver > external_texture_resolver)
	~EmbedderEngine ()
bool	LaunchShell ()
bool	CollectShell ()
void	CollectThreadHost ()
const TaskRunners &	GetTaskRunners () const
bool	NotifyCreated ()
bool	NotifyDestroyed ()
bool	RunRootIsolate ()
bool	IsValid () const
bool	SetViewportMetrics (int64_t view_id, const flutter::ViewportMetrics &metrics)
bool	DispatchPointerDataPacket (std::unique_ptr< flutter::PointerDataPacket > packet)
bool	SendPlatformMessage (std::unique_ptr< PlatformMessage > message)
bool	RegisterTexture (int64_t texture)
bool	UnregisterTexture (int64_t texture)
bool	MarkTextureFrameAvailable (int64_t texture)
bool	SetSemanticsEnabled (bool enabled)
bool	SetAccessibilityFeatures (int32_t flags)
bool	DispatchSemanticsAction (int64_t view_id, int node_id, flutter::SemanticsAction action, fml::MallocMapping args)
bool	OnVsyncEvent (intptr_t baton, fml::TimePoint frame_start_time, fml::TimePoint frame_target_time)
bool	ReloadSystemFonts ()
bool	PostRenderThreadTask (const fml::closure &task)
bool	RunTask (const FlutterTask *task)
bool	PostTaskOnEngineManagedNativeThreads (const std::function< void(FlutterNativeThreadType)> &closure) const
bool	ScheduleFrame ()
Shell &	GetShell ()

Detailed Description

Definition at line 23 of file embedder_engine.h.

Constructor & Destructor Documentation

EmbedderEngine()

flutter::EmbedderEngine::EmbedderEngine	(	std::unique_ptr< EmbedderThreadHost >	thread_host,
		const TaskRunners &	task_runners,
		const Settings &	settings,
		RunConfiguration	run_configuration,
		const Shell::CreateCallback< PlatformView > &	on_create_platform_view,
		const Shell::CreateCallback< Rasterizer > &	on_create_rasterizer,
		std::unique_ptr< EmbedderExternalTextureResolver >	external_texture_resolver
	)

Definition at line 24 of file embedder_engine.cc.

    : thread_host_(std::move(thread_host)),
      task_runners_(task_runners),
      run_configuration_(std::move(run_configuration)),
      shell_args_(std::make_unique<ShellArgs>(settings,
                                              on_create_platform_view,
                                              on_create_rasterizer)),
      external_texture_resolver_(std::move(external_texture_resolver)) {}

~EmbedderEngine()

flutter::EmbedderEngine::~EmbedderEngine ( )

default

Member Function Documentation

CollectShell()

bool flutter::EmbedderEngine::CollectShell

(

)

Definition at line 63 of file embedder_engine.cc.

                                  {
  shell_.reset();
  return IsValid();
}

References IsValid().

CollectThreadHost()

void flutter::EmbedderEngine::CollectThreadHost

(

)

Definition at line 68 of file embedder_engine.cc.

                                       {
  if (!thread_host_) {
    return;
  }
 
  // Once the collected, EmbedderThreadHost::RunnerIsValid will return false for
  // all runners belonging to this thread host. This must be done with UI task
  // runner blocked to prevent possible raciness that could happen when
  // destroying the thread host in the middle of UI task runner execution. This
  // is not an issue for other runners, because raster task runner should not
  // have anything scheduled after engine shutdown and platform task runner is
  // where this method is called from.
  if (thread_host_->GetTaskRunners().GetUITaskRunner() &&
      !thread_host_->GetTaskRunners()
           .GetUITaskRunner()
           ->RunsTasksOnCurrentThread()) {
    fml::AutoResetWaitableEvent ui_thread_running;
    fml::AutoResetWaitableEvent ui_thread_block;
    fml::AutoResetWaitableEvent ui_thread_finished;
 
    thread_host_->GetTaskRunners().GetUITaskRunner()->PostTask([&] {
      ui_thread_running.Signal();
      ui_thread_block.Wait();
      ui_thread_finished.Signal();
    });
 
    // Wait until the task is running on the UI thread.
    ui_thread_running.Wait();
    thread_host_->InvalidateActiveRunners();
    ui_thread_block.Signal();
 
    // Needed to keep ui_thread_block in scope until the UI thread execution
    // finishes.
    ui_thread_finished.Wait();
  } else {
    thread_host_->InvalidateActiveRunners();
  }
  thread_host_.reset();
}

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

DispatchPointerDataPacket()

bool flutter::EmbedderEngine::DispatchPointerDataPacket

(

std::unique_ptr< flutter::PointerDataPacket >

packet

)

Definition at line 158 of file embedder_engine.cc.

                                                    {
  if (!IsValid() || !packet) {
    return false;
  }
 
  auto platform_view = shell_->GetPlatformView();
  if (!platform_view) {
    return false;
  }
 
  platform_view->DispatchPointerDataPacket(std::move(packet));
  return true;
}

References IsValid(), and platform_view.

DispatchSemanticsAction()

bool flutter::EmbedderEngine::DispatchSemanticsAction	(	int64_t	view_id,
		int	node_id,
		flutter::SemanticsAction	action,
		fml::MallocMapping	args
	)

Definition at line 238 of file embedder_engine.cc.

                                                                    {
  if (!IsValid()) {
    return false;
  }
  auto platform_view = shell_->GetPlatformView();
  if (!platform_view) {
    return false;
  }
  platform_view->DispatchSemanticsAction(view_id, node_id, action,
                                         std::move(args));
  return true;
}

References action, args, IsValid(), platform_view, and view_id.

Referenced by FlutterEngineSendSemanticsAction().

GetShell()

Shell & flutter::EmbedderEngine::GetShell

(

)

Definition at line 347 of file embedder_engine.cc.

                                {
  FML_DCHECK(shell_);
  return *shell_.get();
}

References FML_DCHECK.

Referenced by FlutterEngineSetNextFrameCallback(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

GetTaskRunners()

const TaskRunners & flutter::EmbedderEngine::GetTaskRunners

(

)

const

Definition at line 120 of file embedder_engine.cc.

                                                        {
  return task_runners_;
}

Referenced by flutter::testing::TEST_F().

IsValid()

bool flutter::EmbedderEngine::IsValid

(

)

const

Definition at line 116 of file embedder_engine.cc.

                                   {
  return static_cast<bool>(shell_);
}

Referenced by CollectShell(), DispatchPointerDataPacket(), DispatchSemanticsAction(), LaunchShell(), MarkTextureFrameAvailable(), NotifyCreated(), NotifyDestroyed(), OnVsyncEvent(), PostRenderThreadTask(), PostTaskOnEngineManagedNativeThreads(), RegisterTexture(), ReloadSystemFonts(), RunRootIsolate(), ScheduleFrame(), SendPlatformMessage(), SetAccessibilityFeatures(), SetSemanticsEnabled(), SetViewportMetrics(), and UnregisterTexture().

LaunchShell()

bool flutter::EmbedderEngine::LaunchShell

(

)

Definition at line 42 of file embedder_engine.cc.

                                 {
  if (!shell_args_) {
    FML_DLOG(ERROR) << "Invalid shell arguments.";
    return false;
  }
 
  if (shell_) {
    FML_DLOG(ERROR) << "Shell already initialized";
  }
 
  shell_ = Shell::Create(
      flutter::PlatformData(), task_runners_, shell_args_->settings,
      shell_args_->on_create_platform_view, shell_args_->on_create_rasterizer);
 
  // Reset the args no matter what. They will never be used to initialize a
  // shell again.
  shell_args_.reset();
 
  return IsValid();
}

References flutter::Shell::Create(), FML_DLOG, and IsValid().

MarkTextureFrameAvailable()

bool flutter::EmbedderEngine::MarkTextureFrameAvailable

(

int64_t

texture

)

Definition at line 205 of file embedder_engine.cc.

                                                              {
  if (!IsValid()) {
    return false;
  }
  shell_->GetPlatformView()->MarkTextureFrameAvailable(texture);
  return true;
}

References IsValid(), and texture.

NotifyCreated()

bool flutter::EmbedderEngine::NotifyCreated

(

)

Definition at line 124 of file embedder_engine.cc.

                                   {
  if (!IsValid()) {
    return false;
  }
 
  shell_->GetPlatformView()->NotifyCreated();
  return true;
}

References IsValid().

NotifyDestroyed()

bool flutter::EmbedderEngine::NotifyDestroyed

(

)

Definition at line 133 of file embedder_engine.cc.

                                     {
  if (!IsValid()) {
    return false;
  }
 
  shell_->GetPlatformView()->NotifyDestroyed();
 
  return true;
}

References IsValid().

Referenced by FlutterEngineDeinitialize().

OnVsyncEvent()

bool flutter::EmbedderEngine::OnVsyncEvent	(	intptr_t	baton,
		fml::TimePoint	frame_start_time,
		fml::TimePoint	frame_target_time
	)

Definition at line 254 of file embedder_engine.cc.

                                                                  {
  if (!IsValid()) {
    return false;
  }
 
  return VsyncWaiterEmbedder::OnEmbedderVsync(
      task_runners_, baton, frame_start_time, frame_target_time);
}

References IsValid(), and flutter::VsyncWaiterEmbedder::OnEmbedderVsync().

PostRenderThreadTask()

bool flutter::EmbedderEngine::PostRenderThreadTask

(

const fml::closure &

task

)

Definition at line 273 of file embedder_engine.cc.

                                                                {
  if (!IsValid()) {
    return false;
  }
 
  shell_->GetTaskRunners().GetRasterTaskRunner()->PostTask(task);
  return true;
}

References IsValid().

PostTaskOnEngineManagedNativeThreads()

bool flutter::EmbedderEngine::PostTaskOnEngineManagedNativeThreads

(

const std::function< void(FlutterNativeThreadType)> &

closure

)

const

Definition at line 305 of file embedder_engine.cc.

                                                                     {
  if (!IsValid() || closure == nullptr) {
    return false;
  }
 
  const auto trampoline = [closure](
                              FlutterNativeThreadType type,
                              const fml::RefPtr<fml::TaskRunner>& runner) {
    runner->PostTask([closure, type] { closure(type); });
  };
 
  // Post the task to all thread host threads.
  const auto& task_runners = shell_->GetTaskRunners();
  trampoline(kFlutterNativeThreadTypeRender,
             task_runners.GetRasterTaskRunner());
  trampoline(kFlutterNativeThreadTypeWorker, task_runners.GetIOTaskRunner());
  trampoline(kFlutterNativeThreadTypeUI, task_runners.GetUITaskRunner());
  trampoline(kFlutterNativeThreadTypePlatform,
             task_runners.GetPlatformTaskRunner());
 
  // Post the task to all worker threads.
  auto vm = shell_->GetDartVM();
  vm->GetConcurrentMessageLoop()->PostTaskToAllWorkers(
      [closure]() { closure(kFlutterNativeThreadTypeWorker); });
 
  return true;
}

References IsValid(), kFlutterNativeThreadTypePlatform, kFlutterNativeThreadTypeRender, kFlutterNativeThreadTypeUI, kFlutterNativeThreadTypeWorker, and type.

RegisterTexture()

bool flutter::EmbedderEngine::RegisterTexture

(

int64_t

texture

)

Definition at line 188 of file embedder_engine.cc.

                                                    {
  if (!IsValid()) {
    return false;
  }
  shell_->GetPlatformView()->RegisterTexture(
      external_texture_resolver_->ResolveExternalTexture(texture));
  return true;
}

References IsValid(), and texture.

ReloadSystemFonts()

bool flutter::EmbedderEngine::ReloadSystemFonts

(

)

Definition at line 265 of file embedder_engine.cc.

                                       {
  if (!IsValid()) {
    return false;
  }
 
  return shell_->ReloadSystemFonts();
}

References IsValid().

RunRootIsolate()

bool flutter::EmbedderEngine::RunRootIsolate

(

)

Definition at line 108 of file embedder_engine.cc.

                                    {
  if (!IsValid() || !run_configuration_.IsValid()) {
    return false;
  }
  shell_->RunEngine(std::move(run_configuration_));
  return true;
}

References flutter::RunConfiguration::IsValid(), and IsValid().

RunTask()

bool flutter::EmbedderEngine::RunTask

(

const FlutterTask *

task

)

Definition at line 282 of file embedder_engine.cc.

                                                    {
  // The shell doesn't need to be running or valid for access to the thread
  // host. This is why there is no `IsValid` check here. This allows embedders
  // to perform custom task runner interop before the shell is running.
  if (task == nullptr) {
    return false;
  }
  auto result = thread_host_->PostTask(reinterpret_cast<intptr_t>(task->runner),
                                       task->task);
  // If the UI and platform threads are separate, the microtask queue is
  // flushed through MessageLoopTaskQueues observer.
  // If the UI and platform threads are merged, the UI task runner has no
  // associated task queue, and microtasks need to be flushed manually
  // after running the task.
  if (result && shell_ && task_runners_.GetUITaskRunner() &&
      task_runners_.GetUITaskRunner()->RunsTasksOnCurrentThread() &&
      !task_runners_.GetUITaskRunner()->GetTaskQueueId().is_valid()) {
    shell_->FlushMicrotaskQueue();
  }
 
  return result;
}

References fml::TaskRunner::GetTaskQueueId(), flutter::TaskRunners::GetUITaskRunner(), fml::TaskQueueId::is_valid(), FlutterTask::runner, fml::TaskRunner::RunsTasksOnCurrentThread(), and FlutterTask::task.

ScheduleFrame()

bool flutter::EmbedderEngine::ScheduleFrame

(

)

Definition at line 334 of file embedder_engine.cc.

                                   {
  if (!IsValid()) {
    return false;
  }
 
  auto platform_view = shell_->GetPlatformView();
  if (!platform_view) {
    return false;
  }
  platform_view->ScheduleFrame();
  return true;
}

References IsValid(), and platform_view.

SendPlatformMessage()

bool flutter::EmbedderEngine::SendPlatformMessage

(

std::unique_ptr< PlatformMessage >

message

)

Definition at line 173 of file embedder_engine.cc.

                                            {
  if (!IsValid() || !message) {
    return false;
  }
 
  auto platform_view = shell_->GetPlatformView();
  if (!platform_view) {
    return false;
  }
 
  platform_view->DispatchPlatformMessage(std::move(message));
  return true;
}

References IsValid(), message, and platform_view.

SetAccessibilityFeatures()

bool flutter::EmbedderEngine::SetAccessibilityFeatures

(

int32_t

flags

)

Definition at line 226 of file embedder_engine.cc.

                                                           {
  if (!IsValid()) {
    return false;
  }
  auto platform_view = shell_->GetPlatformView();
  if (!platform_view) {
    return false;
  }
  platform_view->SetAccessibilityFeatures(flags);
  return true;
}

References IsValid(), and platform_view.

SetSemanticsEnabled()

bool flutter::EmbedderEngine::SetSemanticsEnabled

(

bool

enabled

)

Definition at line 213 of file embedder_engine.cc.

                                                     {
  if (!IsValid()) {
    return false;
  }
 
  auto platform_view = shell_->GetPlatformView();
  if (!platform_view) {
    return false;
  }
  platform_view->SetSemanticsEnabled(enabled);
  return true;
}

References IsValid(), and platform_view.

SetViewportMetrics()

bool flutter::EmbedderEngine::SetViewportMetrics	(	int64_t	view_id,
		const flutter::ViewportMetrics &	metrics
	)

Definition at line 143 of file embedder_engine.cc.

                                           {
  if (!IsValid()) {
    return false;
  }
 
  auto platform_view = shell_->GetPlatformView();
  if (!platform_view) {
    return false;
  }
  platform_view->SetViewportMetrics(view_id, metrics);
  return true;
}

References IsValid(), platform_view, and view_id.

UnregisterTexture()

bool flutter::EmbedderEngine::UnregisterTexture

(

int64_t

texture

)

Definition at line 197 of file embedder_engine.cc.

                                                      {
  if (!IsValid()) {
    return false;
  }
  shell_->GetPlatformView()->UnregisterTexture(texture);
  return true;
}

References IsValid(), and texture.

---

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

• shell/platform/embedder/embedder_engine.h
• shell/platform/embedder/embedder_engine.cc