fuchsia_component_decl

Namespaces

Enumerations

enum class StorageId : uint32_t
Name Value Comments
kStaticInstanceId 1u

Isolated storage directories are keyed using a component's instance ID
specified in the component ID index. Components which are not listed in
the index cannot use or open this storage capability.
kStaticInstanceIdOrMoniker 2u

Isolated storage directories are keyed using a component's instance ID
if one is specified in the component ID index. Otherwise, a component's
moniker from the storage capability is used to key its isolated
storage directory.

Declares which identifier to use to key a component's isolated storage

directory.

Defined at line 119 of file fidling/gen/sdk/fidl/fuchsia.component.decl/fuchsia.component.decl/cpp/fidl/fuchsia.component.decl/cpp/common_types.h

enum class StartupMode : uint32_t
Name Value Comments
kLazy 0u

Start component instance only when it receives an incoming capability request or it's
started directly with [`fuchsia.component/Controller.Start`].
kEager 1u

Start component instance automatically when the parent starts or (for dynamic
components) when the component is created.

Describes under what conditions the component may be started.

Defined at line 150 of file fidling/gen/sdk/fidl/fuchsia.component.decl/fuchsia.component.decl/cpp/fidl/fuchsia.component.decl/cpp/common_types.h

enum class OnTerminate : uint32_t
Name Value Comments
kNone 0u

No action, the default
kReboot 1u

Trigger a graceful system reboot if the component terminates, unless its controller reports
via [`fuchsia.component.runner/ComponentController.OnStop`] a `termination_status` of Ok and
an `exit_code` that is either unset or 0. This is a specialized feature gated by Component
Framework security policy.

Describes the action to take if this component instance terminates

unexpectedly.

Defined at line 179 of file fidling/gen/sdk/fidl/fuchsia.component.decl/fuchsia.component.decl/cpp/fidl/fuchsia.component.decl/cpp/common_types.h

enum class Durability : uint32_t
Name Value Comments
kTransient 2u

An instance exists until either its parent instance is stopped
or it is explicitly destroyed.
kSingleRun 3u

An instance is started upon creation and is immediately destroyed when
it stops.

The durability of component instances created in a collection.

Defined at line 208 of file fidling/gen/sdk/fidl/fuchsia.component.decl/fuchsia.component.decl/cpp/fidl/fuchsia.component.decl/cpp/common_types.h

enum class AllowedOffers : uint32_t
Name Value Comments
kStaticOnly 1u

Only static offers may target components in the collection. "Static
offers" are the offers in the `ComponentDecl` that target the collection
itself.

This is the default behavior.
kStaticAndDynamic 2u

Both static offers and dynamic offers may target components in the
collection. "Static offers" are the offers in the `ComponentDecl` that
target the collection itself. "Dynamic offers" are additional offers
that are passed to `CreateChild` at runtime.

The kinds of offers that can target the children in a collection.

Defined at line 236 of file fidling/gen/sdk/fidl/fuchsia.component.decl/fuchsia.component.decl/cpp/fidl/fuchsia.component.decl/cpp/common_types.h

enum class EnvironmentExtends : uint32_t
Name Value Comments
kNone 0u

The environment has no initial set of properties.
kRealm 1u

The environment's initial set of properties are inherited from its realm.
Inherited properties include any fields defined in `EnvironmentDecl`.

Specifies how a declared environment's initial set of properties are assigned.

Defined at line 405 of file fidling/gen/sdk/fidl/fuchsia.component.decl/fuchsia.component.decl/cpp/fidl/fuchsia.component.decl/cpp/common_types.h

enum class DependencyType : uint32_t
Name Value Comments
kStrong 1u

A strong dependency which may be required by components that use it.
kWeak 2u

A weak dependency which is allowed to form a cycle. Components that use
a weak dependency must support the dependency being unavailable at
arbitrary times.

Describes the type of dependency implied by the capability.

Defined at line 432 of file fidling/gen/sdk/fidl/fuchsia.component.decl/fuchsia.component.decl/cpp/fidl/fuchsia.component.decl/cpp/common_types.h

enum class Availability : uint32_t
Name Value Comments
kRequired 1u

The capability must be available. Failure to route the capability is an
error.
kOptional 2u

Inside a use declaration: the component can function if it fails to
obtain the capability.

Inside an offer/expose declaration: the capability may not be available
in some system configurations. As a corollary, the target component must
not have a required dependency on the capability.
kSameAsTarget 3u

If the target of the corresponding offer or expose declaration requires
the capability, then the behavior is equivalent to required. If the
target has an optional dependency on the capability, then the behavior
is equivalent to optional. This is useful for container components that
would like to change their routing availability based on ones inside.

This value is not allowed inside a use declaration.
kTransitional 4u

The source may omit the route completely without even having to route
from `void`.

[`TRANSITIONAL`] is used for soft transitions that introduce new
capabilities.

Describes the expected availability of the capability.

Some capabilities may not be present on all system configurations. In those

cases, the availability will be declared as `OPTIONAL` along the chains of

exposes/offers/uses, and the capability would be routed from `void` on

system configurations where it does not make sense to route or provide a

particular capability (e.g. graphical capabilities on a headless system).

Defined at line 466 of file fidling/gen/sdk/fidl/fuchsia.component.decl/fuchsia.component.decl/cpp/fidl/fuchsia.component.decl/cpp/common_types.h

Records