class ComponentStartInfo

Defined at line 325 of file fidling/gen/sdk/fidl/fuchsia.component.runner/fuchsia.component.runner/cpp/fidl/fuchsia.component.runner/cpp/wire_types.h

Parameters for starting a new component instance.

Public Methods

void ComponentStartInfo ()

Defined at line 327 of file fidling/gen/sdk/fidl/fuchsia.component.runner/fuchsia.component.runner/cpp/fidl/fuchsia.component.runner/cpp/wire_types.h

void ComponentStartInfo (const ComponentStartInfo & other)

Defined at line 328 of file fidling/gen/sdk/fidl/fuchsia.component.runner/fuchsia.component.runner/cpp/fidl/fuchsia.component.runner/cpp/wire_types.h

void ComponentStartInfo (ComponentStartInfo && other)

Defined at line 330 of file fidling/gen/sdk/fidl/fuchsia.component.runner/fuchsia.component.runner/cpp/fidl/fuchsia.component.runner/cpp/wire_types.h

bool IsEmpty ()

Returns whether no field is set.

bool HasUnknownData ()

Returns whether the table references unknown fields.

void _CloseHandles ()

::fidl::WireTableBuilder< ::fuchsia_component_runner::wire::ComponentStartInfo> Builder (::fidl::AnyArena & arena)

Return a builder that by defaults allocates of an arena.

::fidl::WireTableExternalBuilder< ::fuchsia_component_runner::wire::ComponentStartInfo> ExternalBuilder (::fidl::ObjectView< ::fidl::WireTableFrame< ::fuchsia_component_runner::wire::ComponentStartInfo>> frame)

Return a builder that relies on explicitly allocating |fidl::ObjectView|s.

::fidl::StringView & resolved_url ()

The URL of the component. Called `resolved_url` instead of just `url`

for historical reasons.

bool has_resolved_url ()

::fuchsia_data::wire::Dictionary & program ()

The component's program declaration.

This information originates from `ComponentDecl.program`.

bool has_program ()

::fidl::VectorView< ::fuchsia_component_runner::wire::ComponentNamespaceEntry> & ns ()

The namespace to provide to the component instance.

A namespace specifies the set of directories that a component instance

receives at start-up. Through the namespace directories, a component

may access capabilities available to it. The contents of the namespace

are mainly determined by the component's `use` declarations but may

also contain additional capabilities automatically provided by the

framework.

By convention, a component's namespace typically contains some or all

of the following directories:

- "/svc": A directory containing services that the component requested

to use via its "import" declarations.

- "/pkg": A directory containing the component's package, including its

binaries, libraries, and other assets.

The mount points specified in each entry must be unique and

non-overlapping. For example, [{"/foo", ..}, {"/foo/bar", ..}] is

invalid.

bool has_ns ()

::fidl::ServerEnd< ::fuchsia_io::Directory> & outgoing_dir ()

The directory this component serves.

bool has_outgoing_dir ()

::fidl::ServerEnd< ::fuchsia_io::Directory> & runtime_dir ()

The directory served by the runner to present runtime information about

the component. The runner must either serve it, or drop it to avoid

blocking any consumers indefinitely.

bool has_runtime_dir ()

::fidl::VectorView< ::fuchsia_process::wire::HandleInfo> & numbered_handles ()

The numbered handles that were passed to the component.

If the component does not support numbered handles, the runner is expected

to close the handles.

bool has_numbered_handles ()

::fuchsia_mem::wire::Data & encoded_config ()

Binary representation of the component's configuration.

# Layout

The first 2 bytes of the data should be interpreted as an unsigned 16-bit

little-endian integer which denotes the number of bytes following it that

contain the configuration checksum. After the checksum, all the remaining

bytes are a persistent FIDL message of a top-level struct. The struct's

fields match the configuration fields of the component's compiled manifest

in the same order.

bool has_encoded_config ()

::zx::eventpair & break_on_start ()

An eventpair that debuggers can use to defer the launch of the component.

For example, ELF runners hold off from creating processes in the component

until ZX_EVENTPAIR_PEER_CLOSED is signaled on this eventpair. They also

ensure that runtime_dir is served before waiting on this eventpair.

ELF debuggers can query the runtime_dir to decide whether to attach before

they drop the other side of the eventpair, which is sent in the payload of

the DebugStarted event in fuchsia.component.events.

bool has_break_on_start ()

::zx::event & component_instance ()

An opaque token that represents the component instance.

The `fuchsia.component/Introspector` protocol may be used to get the

string moniker of the instance from this token.

Runners may publish this token as part of diagnostics information, to

identify the running component without knowing its moniker.

The token is invalidated when the component instance is destroyed.

bool has_component_instance ()

::fuchsia_component_sandbox::wire::DictionaryRef & escrowed_dictionary ()

A dictionary containing data and handles that the component has escrowed

during its previous execution via [`ComponentController.OnEscrow`]. Note

that this field is considered deprecated, please use

`escrowed_dictionary_handle` instead.

bool has_escrowed_dictionary ()

::zx::eventpair & escrowed_dictionary_handle ()

A dictionary containing data and handles that the component has escrowed

during its previous execution via [`ComponentController.OnEscrow`].

bool has_escrowed_dictionary_handle ()

ComponentStartInfo & set_resolved_url (::fidl::ObjectView< ::fidl::StringView> elem)

ComponentStartInfo & set_resolved_url (std::nullptr_t )

ComponentStartInfo & clear_resolved_url ()

ComponentStartInfo & set_program (::fidl::ObjectView< ::fuchsia_data::wire::Dictionary> elem)

ComponentStartInfo & set_program (std::nullptr_t )

ComponentStartInfo & clear_program ()

ComponentStartInfo & set_ns (::fidl::ObjectView< ::fidl::VectorView< ::fuchsia_component_runner::wire::ComponentNamespaceEntry>> elem)

ComponentStartInfo & set_ns (std::nullptr_t )

ComponentStartInfo & clear_ns ()

ComponentStartInfo & set_outgoing_dir (::fidl::ServerEnd< ::fuchsia_io::Directory> elem)

ComponentStartInfo & clear_outgoing_dir ()

ComponentStartInfo & set_runtime_dir (::fidl::ServerEnd< ::fuchsia_io::Directory> elem)

ComponentStartInfo & clear_runtime_dir ()

ComponentStartInfo & set_numbered_handles (::fidl::ObjectView< ::fidl::VectorView< ::fuchsia_process::wire::HandleInfo>> elem)

ComponentStartInfo & set_numbered_handles (std::nullptr_t )

ComponentStartInfo & clear_numbered_handles ()

ComponentStartInfo & set_encoded_config (::fidl::ObjectView< ::fuchsia_mem::wire::Data> elem)

ComponentStartInfo & set_encoded_config (std::nullptr_t )

ComponentStartInfo & clear_encoded_config ()

ComponentStartInfo & set_break_on_start (::zx::eventpair elem)

ComponentStartInfo & clear_break_on_start ()

ComponentStartInfo & set_component_instance (::zx::event elem)

ComponentStartInfo & clear_component_instance ()

ComponentStartInfo & set_escrowed_dictionary (::fuchsia_component_sandbox::wire::DictionaryRef elem)

ComponentStartInfo & clear_escrowed_dictionary ()

ComponentStartInfo & set_escrowed_dictionary_handle (::zx::eventpair elem)

ComponentStartInfo & clear_escrowed_dictionary_handle ()

void ComponentStartInfo (::fidl::AnyArena & allocator)

void ComponentStartInfo (::fidl::ObjectView< ::fidl::WireTableFrame< ::fuchsia_component_runner::wire::ComponentStartInfo>> && frame)

This constructor allows a user controlled allocation (not using a Arena).

It should only be used when performance is key.

As soon as the frame is given to the table, it must not be used directly or for another table.

void Allocate (::fidl::AnyArena & allocator)

void Init (::fidl::ObjectView< ::fidl::WireTableFrame< ::fuchsia_component_runner::wire::ComponentStartInfo>> && frame_ptr)

ComponentStartInfo & operator= (const ComponentStartInfo & other)

Defined at line 329 of file fidling/gen/sdk/fidl/fuchsia.component.runner/fuchsia.component.runner/cpp/fidl/fuchsia.component.runner/cpp/wire_types.h

ComponentStartInfo & operator= (ComponentStartInfo && other)

Defined at line 331 of file fidling/gen/sdk/fidl/fuchsia.component.runner/fuchsia.component.runner/cpp/fidl/fuchsia.component.runner/cpp/wire_types.h

void ~ComponentStartInfo ()

Defined at line 333 of file fidling/gen/sdk/fidl/fuchsia.component.runner/fuchsia.component.runner/cpp/fidl/fuchsia.component.runner/cpp/wire_types.h

Friends

class WireTableBaseBuilder

class WireTableBaseBuilder