flutter_runner::ComponentV2 Class Reference

#include <component_v2.h>

Inheritance diagram for flutter_runner::ComponentV2:

Public Types
using	TerminationCallback = fit::function< void(const ComponentV2 *)>

Public Member Functions
	~ComponentV2 ()
const std::string &	GetDebugLabel () const
void	WriteProfileToTrace () const

Static Public Member Functions
static ActiveComponentV2	Create (TerminationCallback termination_callback, fuchsia::component::runner::ComponentStartInfo start_info, std::shared_ptr< sys::ServiceDirectory > runner_incoming_services, fidl::InterfaceRequest< fuchsia::component::runner::ComponentController > controller)
static ProgramMetadata	ParseProgramMetadata (const fuchsia::data::Dictionary &program_metadata)

Private Member Functions
void	Kill () override
void	Stop () override
void	CreateView2 (fuchsia::ui::app::CreateView2Args view_args) override
void	CreateViewWithViewRef (::zx::eventpair token, ::fuchsia::ui::views::ViewRefControl view_ref_control, ::fuchsia::ui::views::ViewRef view_ref) override
void	OnEngineTerminate (const Engine *holder) override

Detailed Description

Definition at line 56 of file component_v2.h.

Member Typedef Documentation

TerminationCallback

using flutter_runner::ComponentV2::TerminationCallback = fit::function<void(const ComponentV2*)>

Definition at line 61 of file component_v2.h.

Constructor & Destructor Documentation

~ComponentV2()

flutter_runner::ComponentV2::~ComponentV2 ( )

default

Member Function Documentation

Create()

ActiveComponentV2 flutter_runner::ComponentV2::Create ( TerminationCallback  termination_callback, fuchsia::component::runner::ComponentStartInfo  start_info, std::shared_ptr< sys::ServiceDirectory >  runner_incoming_services, fidl::InterfaceRequest< fuchsia::component::runner::ComponentController >  controller  )

static

Definition at line 128 of file component_v2.cc.

                    {
  auto thread = std::make_unique<fml::Thread>();
  std::unique_ptr<ComponentV2> component;
 
  fml::AutoResetWaitableEvent latch;
  thread->GetTaskRunner()->PostTask([&]() mutable {
    component.reset(
        new ComponentV2(std::move(termination_callback), std::move(start_info),
                        runner_incoming_services, std::move(controller)));
    latch.Signal();
  });
 
  latch.Wait();
  return {.platform_thread = std::move(thread),
          .component = std::move(component)};
}

CreateView2()

void flutter_runner::ComponentV2::CreateView2 ( fuchsia::ui::app::CreateView2Args  view_args )

overrideprivate

Definition at line 620 of file component_v2.cc.

                                                                   {
  if (!svc_) {
    FML_LOG(ERROR)
        << "Component incoming services was invalid when attempting to "
           "create a shell for a view provider request.";
    return;
  }
 
  fuchsia::ui::views::ViewRefControl view_ref_control;
  fuchsia::ui::views::ViewRef view_ref;
  auto status = zx::eventpair::create(
      /*options*/ 0u, &view_ref_control.reference, &view_ref.reference);
  ZX_ASSERT(status == ZX_OK);
  view_ref_control.reference.replace(
      ZX_DEFAULT_EVENTPAIR_RIGHTS & (~ZX_RIGHT_DUPLICATE),
      &view_ref_control.reference);
  view_ref.reference.replace(ZX_RIGHTS_BASIC, &view_ref.reference);
  auto view_ref_pair =
      std::make_pair(std::move(view_ref_control), std::move(view_ref));
 
  shell_holders_.emplace(std::make_unique<Engine>(
      *this,                      // delegate
      debug_label_,               // thread label
      svc_,                       // Component incoming services
      runner_incoming_services_,  // Runner incoming services
      settings_,                  // settings
      std::move(
          *view_args.mutable_view_creation_token()),  // view creation token
      std::move(view_ref_pair),                       // view ref pair
      std::move(fdio_ns_),                            // FDIO namespace
      std::move(directory_request_),                  // outgoing request
      product_config_,                                // product configuration
      std::vector<std::string>()                      // dart entrypoint args
      ));
}

CreateViewWithViewRef()

void flutter_runner::ComponentV2::CreateViewWithViewRef ( ::zx::eventpair  token, ::fuchsia::ui::views::ViewRefControl  view_ref_control, ::fuchsia::ui::views::ViewRef  view_ref  )

inlineoverrideprivate

Definition at line 114 of file component_v2.h.

                                               {}

GetDebugLabel()

const std::string & flutter_runner::ComponentV2::GetDebugLabel

(

)

const

Definition at line 535 of file component_v2.cc.

                                                  {
  return debug_label_;
}

Kill()

void flutter_runner::ComponentV2::Kill ( )

overrideprivate

Definition at line 539 of file component_v2.cc.

                       {
  FML_VLOG(1) << "received Kill event";
 
  // From the documentation for ComponentController, ZX_OK should be sent when
  // the ComponentController receives a termination request. However, if the
  // component exited with a non-zero return code, we indicate this by sending
  // an INTERNAL epitaph instead.
  //
  // TODO(fxb/86666): Communicate return code from the ComponentController once
  // v2 has support.
  auto [got_return_code, return_code] = last_return_code_;
  if (got_return_code && return_code == 0) {
    KillWithEpitaph(ZX_OK);
  } else {
    if (got_return_code) {
      FML_LOG(ERROR) << "Component exited with non-zero return code: "
                     << return_code;
    } else {
      FML_LOG(ERROR) << "Failed to get return code for component";
    }
 
    KillWithEpitaph(zx_status_t(fuchsia::component::Error::INTERNAL));
  }
 
  // WARNING: Don't do anything past this point as this instance may have been
  // collected.
}

OnEngineTerminate()

void flutter_runner::ComponentV2::OnEngineTerminate ( const Engine *  holder )

overrideprivatevirtual

Implements flutter_runner::Engine::Delegate.

Definition at line 584 of file component_v2.cc.

                                                              {
  auto found = std::find_if(shell_holders_.begin(), shell_holders_.end(),
                            [shell_holder](const auto& holder) {
                              return holder.get() == shell_holder;
                            });
 
  if (found == shell_holders_.end()) {
    // This indicates a deeper issue with memory management and should never
    // happen.
    FML_LOG(ERROR) << "Tried to terminate an unregistered shell holder.";
    FML_DCHECK(false);
 
    return;
  }
 
  // We may launch multiple shells in this component. However, we will
  // terminate when the last shell goes away. The error code returned to the
  // component controller will be the last isolate that had an error.
  auto return_code = shell_holder->GetEngineReturnCode();
  if (return_code.has_value()) {
    last_return_code_ = {true, return_code.value()};
  } else {
    FML_LOG(ERROR) << "Failed to get return code from terminated shell holder.";
  }
 
  shell_holders_.erase(found);
 
  if (shell_holders_.empty()) {
    FML_VLOG(1) << "Killing component because all shell holders have been "
                   "terminated.";
    Kill();
    // WARNING: Don't do anything past this point because the delegate may have
    // collected this instance via the termination callback.
  }
}

ParseProgramMetadata()

ProgramMetadata flutter_runner::ComponentV2::ParseProgramMetadata ( const fuchsia::data::Dictionary &  program_metadata )

static

Parses the program metadata that was provided for the component.

|old_gen_heap_size| will be set to -1 if no value was specified.

Definition at line 106 of file component_v2.cc.

                                                   {
  ProgramMetadata result;
 
  for (const auto& entry : program_metadata.entries()) {
    if (entry.key.compare(kDataKey) == 0 && entry.value != nullptr) {
      result.data_path = "pkg/" + entry.value->str();
    } else if (entry.key.compare(kAssetsKey) == 0 && entry.value != nullptr) {
      result.assets_path = "pkg/" + entry.value->str();
    } else if (entry.key.compare(kArgsKey) == 0 && entry.value != nullptr) {
      ParseArgs(entry.value->str_vec(), &result);
    }
  }
 
  // assets_path defaults to the same as data_path if omitted.
  if (result.assets_path.empty()) {
    result.assets_path = result.data_path;
  }
 
  return result;
}

Stop()

void flutter_runner::ComponentV2::Stop ( )

overrideprivate

Definition at line 576 of file component_v2.cc.

                       {
  FML_VLOG(1) << "received Stop event";
 
  // TODO(fxb/89162): Any other cleanup logic we should do that's appropriate
  // for Stop but not for Kill?
  KillWithEpitaph(ZX_OK);
}

WriteProfileToTrace()

void flutter_runner::ComponentV2::WriteProfileToTrace

(

)

const

Definition at line 657 of file component_v2.cc.

                                            {
  for (const auto& engine : shell_holders_) {
    engine->WriteProfileToTrace();
  }
}

---

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

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