fuchsia.component.runtime

Added: HEAD

PROTOCOLS

Capabilities

Defined in fuchsia.component.runtime/capabilities.fidl

An API for creating and manipulating references to runtime capabilities in the component framework. These capabilities are all reference counted by component manager, and when accessed with this protocol the references are implemented as event pair handles.

Added: HEAD

ConnectorCreate

Creates a reference to a new connector capability. When the connector is opened, the channel given to the open call will be sent over receiver_client_end.

Make sure this method returns before passing the handle's peer to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`connector`	`handle<eventpair>`
`receiver_client_end`	`client_end:Receiver`

Response

Name	Type
`payload`	`Capabilities_ConnectorCreate_Result`

ConnectorOpen

Uses the provided connector to open a new connection by delivering this channel to whoever created the connector.

If there is an error, it will be reported as a zx.Status epitaph on channel.

If the connector event pair handle is not correlated with a handle given to ConnectorCreate, this connection will be closed.

Request

Name	Type
`connector`	`handle<eventpair>`
`channel`	`handle<channel>`

Response

Name	Type
`payload`	`Capabilities_ConnectorOpen_Result`

ConnectorRouterCreate

Creates a reference to a new router capability that will return a connector capability when used.

Make sure this method returns before passing the handle's peer to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`router`	`handle<eventpair>`
`router_client_end`	`client_end:ConnectorRouter`

Response

Name	Type
`payload`	`Capabilities_ConnectorRouterCreate_Result`

ConnectorRouterRoute

Attempts to produce a Connector capability from this ConnectorRouter.

Make sure this method returns before passing the peer of capability to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`router`	`handle<eventpair>`
`request`	`RouteRequest`
`connector`	`handle<eventpair>`

Response

Name	Type
`payload`	`Capabilities_ConnectorRouterRoute_Result`

DataCreate

Creates a reference to a new data capability with the given value.

Make sure this method returns before passing the handle's peer to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`data_handle`	`handle<eventpair>`
`data`	`Data`

Response

Name	Type
`payload`	`Capabilities_DataCreate_Result`

DataGet

Returns the Data value that was provided to the DataCreate call used with data_handle.

Request

Name	Type
`data_handle`	`handle<eventpair>`

Response

Name	Type
`payload`	`Capabilities_DataGet_Result`

DataRouterCreate

Creates a reference to a new router capability that will return a data value when used.

Make sure this method returns before passing the handle's peer to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`router`	`handle<eventpair>`
`router_client_end`	`client_end:DataRouter`

Response

Name	Type
`payload`	`Capabilities_DataRouterCreate_Result`

DataRouterRoute

Attempts to produce a Data value from this DataRouter. This will return:

A Data value if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`router`	`handle<eventpair>`
`request`	`RouteRequest`
`data_handle`	`zx/Status`

Response

Name	Type
`payload`	`Capabilities_DataRouterRoute_Result`

DictionaryCreate

Creates a reference to a new dictionary capability.

Make sure this method returns before passing the handle's peer to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`dictionary`	`handle<eventpair>`

Response

Name	Type
`payload`	`Capabilities_DictionaryCreate_Result`

DictionaryGet

Creates a new reference to the capability named key in this dictionary, if that capability exists. That capability will remain in the dictionary. To take a capability out of the dictionary, use DictionaryRemove.

If key does not exist, value will not reference any capability and the NO_SUCH_CAPABILITY error value will be returned.

Make sure this method returns before passing the handle's peer to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`dictionary`	`handle<eventpair>`
`key`	`fuchsia.component.decl/name`
`value`	`handle<eventpair>`

Response

Name	Type
`payload`	`Capabilities_DictionaryGet_Result`

DictionaryInsert

Inserts a new capability into this Dictionary under the name key. Overwrites any existing entry.

Request

Name	Type
`dictionary`	`handle<eventpair>`
`key`	`fuchsia.component.decl/name`
`value`	`handle<eventpair>`

Response

Name	Type
`payload`	`Capabilities_DictionaryInsert_Result`

DictionaryIterateKeys

Opens an iterator which can be used to iterate over the keys of this dictionary.

Request

Name	Type
`dictionary`	`handle<eventpair>`
`key_iterator`	`server_end:DictionaryKeyIterator`

Response

Name	Type
`payload`	`Capabilities_DictionaryIterateKeys_Result`

DictionaryRemove

Removes the capability named key from this dictionary and returns a reference to it, if that capability exists.

dictionary and key are required. capability is optional, and when set will become associated with the capability that was removed from the dictionary.

If key does not exist, value will not reference any capability and the NO_SUCH_CAPABILITY error value will be returned.

Make sure this method returns before passing the peer of capability to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`payload`	`CapabilitiesDictionaryRemoveRequest`

Response

Name	Type
`payload`	`Capabilities_DictionaryRemove_Result`

DictionaryRouterCreate

Creates a reference to a new router capability that will return a dictionary capability when used.

Make sure this method returns before passing the handle's peer to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`router`	`handle<eventpair>`
`router_client_end`	`client_end:DictionaryRouter`

Response

Name	Type
`payload`	`Capabilities_DictionaryRouterCreate_Result`

DictionaryRouterRoute

Attempts to produce a Dictionary capability from this DictionaryRouter. This will return:

A Dictionary if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`router`	`handle<eventpair>`
`request`	`RouteRequest`
`dictionary`	`handle<eventpair>`

Response

Name	Type
`payload`	`Capabilities_DictionaryRouterRoute_Result`

DirConnectorCreate

Creates a reference to a new directory connector capability. When the directory connector is opened, the channel given to the open call will be sent over receiver_client_end.

Make sure this method returns before passing the handle's peer to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`dir_connector`	`handle<eventpair>`
`receiver_client_end`	`client_end:DirReceiver`

Response

Name	Type
`payload`	`Capabilities_DirConnectorCreate_Result`

DirConnectorOpen

Uses the provided dir_connector to open a new directory connection by delivering this channel to whoever created the directory connector.

If there is an error, it will be reported as a zx.Status epitaph on channel.

If the dir_connector event pair handle is not correlated with a handle given to DirConnectorCreate, this connection will be closed.

dir_connector and channel are both required. rights and subdir may be omitted.

Request

Name	Type
`payload`	`CapabilitiesDirConnectorOpenRequest`

Response

Name	Type
`payload`	`Capabilities_DirConnectorOpen_Result`

DirConnectorRouterCreate

Creates a reference to a new router capability that will return a directory connector capability when used.

Make sure this method returns before passing the handle's peer to other methods in this API. The creation may not be complete before then.

Request

Name	Type
`router`	`handle<eventpair>`
`router_client_end`	`client_end:DirConnectorRouter`

Response

Name	Type
`payload`	`Capabilities_DirConnectorRouterCreate_Result`

DirConnectorRouterRoute

Attempts to produce a DirConnector capability from this DirConnectorRouter. This will return:

A DirConnector if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`router`	`handle<eventpair>`
`request`	`RouteRequest`
`dir_connector`	`handle<eventpair>`

Response

Name	Type
`payload`	`Capabilities_DirConnectorRouterRoute_Result`

CapabilityFactory

Defined in fuchsia.component.runtime/factory.fidl

The CapabilityFactory can be used to create new runtime capabilities.

Added: HEAD

CreateConnector

Request

Name	Type
`receiver_client_end`	`client_end:Receiver`
`connector_server_end`	`server_end:Connector`

CreateConnectorRouter

Request

Name	Type
`router_client_end`	`client_end:ConnectorRouterDeprecated`
`router_server_end`	`server_end:ConnectorRouterDeprecated`

CreateDataRouter

Request

Name	Type
`router_client_end`	`client_end:DataRouterDeprecated`
`router_server_end`	`server_end:DataRouterDeprecated`

CreateDictionary

Request

Name	Type
`dictionary_server_end`	`server_end:Dictionary`

CreateDictionaryRouter

Request

Name	Type
`router_client_end`	`client_end:DictionaryRouterDeprecated`
`router_server_end`	`server_end:DictionaryRouterDeprecated`

CreateDirConnector

Request

Name	Type
`dir_receiver_client_end`	`client_end:DirReceiverDeprecated`
`dir_connector_server_end`	`server_end:DirConnector`

CreateDirConnectorRouter

Request

Name	Type
`router_client_end`	`client_end:DirConnectorRouterDeprecated`
`router_server_end`	`server_end:DirConnectorRouterDeprecated`

Connector

Defined in fuchsia.component.runtime/factory.fidl

A Connector represents the sending end of a connection to a capability. A Connector presents as a service node when inserted into a fuchsia.io.Directory.

Added: HEAD

Clone

Added: 26

Request

Name	Type
`request`	`server_end:fuchsia.unknown/Cloneable`

Connect

Sends a channel to the Receiver associated with this Connector.

Request

Name	Type
`channel`	`handle<channel>`

ConnectorRouter

Defined in fuchsia.component.runtime/capabilities.fidl

A factory for Connector capabilities.

Added: HEAD

Route

Attempts to produce a Connector capability from this ConnectorRouter. This will return:

A Connector if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`request`	`RouteRequest`

Response

Name	Type
`payload`	`ConnectorRouter_Route_Result`

ConnectorRouterDeprecated

Defined in fuchsia.component.runtime/factory.fidl

A factory for Connector capabilities.

Added: HEAD

Clone

Added: 26

Request

Name	Type
`request`	`server_end:fuchsia.unknown/Cloneable`

Route

Attempts to produce a Connector capability from this ConnectorRouter. This will return:

A Connector if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`request`	`RouteRequest`
`connector_server_end`	`server_end:Connector`

Response

Name	Type
`payload`	`ConnectorRouterDeprecated_Route_Result`

DataRouter

Defined in fuchsia.component.runtime/capabilities.fidl

A factory for Data capabilities.

Added: HEAD

Route

Attempts to produce a Data capability from this DataRouter. This will return:

A Data value if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`request`	`RouteRequest`

Response

Name	Type
`payload`	`DataRouter_Route_Result`

DataRouterDeprecated

Defined in fuchsia.component.runtime/factory.fidl

A factory for Data capabilities.

Added: HEAD

Clone

Added: 26

Request

Name	Type
`request`	`server_end:fuchsia.unknown/Cloneable`

Route

Attempts to produce a Data capability from this DataRouter. This will return:

A Data value if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`request`	`RouteRequest`

Response

Name	Type
`payload`	`DataRouterDeprecated_Route_Result`

Dictionary

Defined in fuchsia.component.runtime/factory.fidl

A Dictionary is a bundle of named runtime capabilities.

Added: HEAD

Clone

Added: 26

Request

Name	Type
`request`	`server_end:fuchsia.unknown/Cloneable`

Get

Returns a clone of the Capability named key in this dictionary, if that capability both exists and can be cloned.

Request

Name	Type
`key`	`fuchsia.component.decl/name`

Response

Name	Type
`payload`	`Dictionary_Get_Result`

Insert

Inserts a new Capability into this Dictionary under the name key. Overwrites any existing entry.

The server end associated with the provided client end must be owned by component manager.

Request

Name	Type
`key`	`fuchsia.component.decl/name`
`capability`	`CapabilityDeprecated`

IterateKeys

Opens an iterator which can be used to iterate over the keys of this dictionary.

Request

Name	Type
`key_iterator`	`server_end:DictionaryKeyIterator`

LegacyExport

Exports this dictionary for use in a fuchsia.component.Realm/CreateChild call.

Request

<EMPTY>

Response

Name	Type
`payload`	`Dictionary_LegacyExport_Result`

Remove

Removes the Capability named key from this dictionary and returns it, if that capability exists.

Request

Name	Type
`key`	`fuchsia.component.decl/name`

Response

Name	Type
`payload`	`Dictionary_Remove_Result`

DictionaryKeyIterator

Defined in fuchsia.component.runtime/capabilities.fidl

Added: HEAD

GetNext

Returns the next set of keys in this dictionary. Returns an empty vector when there are no more keys to iterate.

Request

<EMPTY>

Response

Name	Type
`keys`	`vector<fuchsia.component.decl/name>`

DictionaryRouter

Defined in fuchsia.component.runtime/capabilities.fidl

A factory for Dictionary capabilities.

Added: HEAD

Route

Attempts to produce a Dictionary capability from this DictionaryRouter. This will return:

A Dictionary if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`request`	`RouteRequest`

Response

Name	Type
`payload`	`DictionaryRouter_Route_Result`

DictionaryRouterDeprecated

Defined in fuchsia.component.runtime/factory.fidl

A factory for Dictionary capabilities.

Added: HEAD

Clone

Added: 26

Request

Name	Type
`request`	`server_end:fuchsia.unknown/Cloneable`

Route

Attempts to produce a Dictionary capability from this DictionaryRouter. This will return:

A Dictionary if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`request`	`RouteRequest`
`dictionary_server_end`	`server_end:Dictionary`

Response

Name	Type
`payload`	`DictionaryRouterDeprecated_Route_Result`

DirConnector

Defined in fuchsia.component.runtime/factory.fidl

A DirConnector represents the sending end of a connection to a capability. A DirConnector presents as a directory node when inserted into a fuchsia.io.Directory.

Added: HEAD

Clone

Added: 26

Request

Name	Type
`request`	`server_end:fuchsia.unknown/Cloneable`

Connect

Sends a channel to the DirReceiver associated with this DirConnector.

Request

Name	Type
`channel`	`server_end:fuchsia.io/Directory`

DirConnectorRouter

Defined in fuchsia.component.runtime/capabilities.fidl

A factory for DirConnector capabilities.

Added: HEAD

Route

Attempts to produce a DirConnector capability from this DirConnectorRouter. This will return:

A DirConnector if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`request`	`RouteRequest`

Response

Name	Type
`payload`	`DirConnectorRouter_Route_Result`

DirConnectorRouterDeprecated

Defined in fuchsia.component.runtime/factory.fidl

A factory for DirConnector capabilities.

Added: HEAD

Clone

Added: 26

Request

Name	Type
`request`	`server_end:fuchsia.unknown/Cloneable`

Route

Attempts to produce a DirConnector capability from this DirConnectorRouter. This will return:

A DirConnector if the operation is successful.
An empty value if there is no issue found but the capability is not being provided (for example, an optional route ended in an offer from void).
An error, if the operation failed.

Request

Name	Type
`request`	`RouteRequest`
`dir_connector_server_end`	`server_end:DirConnector`

Response

Name	Type
`payload`	`DirConnectorRouterDeprecated_Route_Result`

DirReceiver

Defined in fuchsia.component.runtime/capabilities.fidl

A DirReceiver represents the receiving end of a DirConnector.

Added: HEAD

Receive

Receive will be called by component manager whenever a new handle has been given to any DirConnector associated with this DirReceiver.

Request

Name	Type
`channel`	`server_end:fuchsia.io/Directory`
`rights`	`fuchsia.io/Flags`

DirReceiverDeprecated

Defined in fuchsia.component.runtime/factory.fidl

A DirReceiver represents the receiving end of a connection to a capability.

Added: HEAD

Receive

Receive will be called by component manager whenever a new handle has been given to any DirConnector associated with this DirReceiver.

Request

Name	Type
`channel`	`server_end:fuchsia.io/Directory`

Receiver

Defined in fuchsia.component.runtime/capabilities.fidl

A Receiver represents the receiving end of a Connector.

Added: HEAD

Receive

Receive will be called by component manager whenever an new handle has been given to any Connector associated with this Receiver.

Request

Name	Type
`channel`	`handle<channel>`

STRUCTS

Capabilities_ConnectorCreate_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_ConnectorOpen_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_ConnectorRouterCreate_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_ConnectorRouterRoute_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DataCreate_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DataRouterCreate_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DataRouterRoute_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DictionaryCreate_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DictionaryGet_Response resource

Defined in fuchsia.component.runtime/capabilities.fidl

Field	Type	Description	Default
`capability_type`	`CapabilityType`		No default

Capabilities_DictionaryInsert_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DictionaryIterateKeys_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DictionaryRemove_Response resource

Defined in fuchsia.component.runtime/capabilities.fidl

Field	Type	Description	Default
`capability_type`	`CapabilityType`		No default

Capabilities_DictionaryRouterCreate_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DictionaryRouterRoute_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DirConnectorCreate_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DirConnectorOpen_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DirConnectorRouterCreate_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

Capabilities_DirConnectorRouterRoute_Response

Defined in fuchsia.component.runtime/capabilities.fidl

<EMPTY>

ConnectorRouterDeprecated_Route_Response resource

Defined in fuchsia.component.runtime/factory.fidl

Field	Type	Description	Default
`response`	`RouterResponse`		No default

ConnectorRouter_Route_Response resource

Defined in fuchsia.component.runtime/capabilities.fidl

Field	Type	Description	Default
`handle`	`handle<eventpair>?`		No default

DataRouterDeprecated_Route_Response resource

Defined in fuchsia.component.runtime/factory.fidl

Field	Type	Description	Default
`response`	`RouterResponse`		No default
`data`	`Data?`		No default

DataRouter_Route_Response resource

Defined in fuchsia.component.runtime/capabilities.fidl

Field	Type	Description	Default
`data`	`Data?`		No default

DictionaryRouterDeprecated_Route_Response resource

Defined in fuchsia.component.runtime/factory.fidl

Field	Type	Description	Default
`response`	`RouterResponse`		No default

DictionaryRouter_Route_Response resource

Defined in fuchsia.component.runtime/capabilities.fidl

Field	Type	Description	Default
`handle`	`handle<eventpair>?`		No default

Dictionary_Get_Response resource

Defined in fuchsia.component.runtime/factory.fidl

Field	Type	Description	Default
`capability`	`CapabilityDeprecated?`		No default

Dictionary_LegacyExport_Response resource

Defined in fuchsia.component.runtime/factory.fidl

Field	Type	Description	Default
`dictionary_ref`	`fuchsia.component.sandbox/DictionaryRef`		No default

Dictionary_Remove_Response resource

Defined in fuchsia.component.runtime/factory.fidl

Field	Type	Description	Default
`capability`	`CapabilityDeprecated?`		No default

DirConnectorRouterDeprecated_Route_Response resource

Defined in fuchsia.component.runtime/factory.fidl

Field	Type	Description	Default
`response`	`RouterResponse`		No default

DirConnectorRouter_Route_Response resource

Defined in fuchsia.component.runtime/capabilities.fidl

Field	Type	Description	Default
`handle`	`handle<eventpair>?`		No default

WeakInstanceToken resource

Defined in fuchsia.component.runtime/capabilities.fidl

A token representing a component instance.

Added: HEAD

Field	Type	Description	Default
`token`	`handle<eventpair>`		No default

ENUMS

CapabilitiesError flexible

Type: uint32

Defined in fuchsia.component.runtime/capabilities.fidl

Added: HEAD

Name	Value	Description
NO_SUCH_CAPABILITY	`1`
INVALID_NAME	`2`
HANDLE_DOES_NOT_REFERENCE_CAPABILITY	`3`
INVALID_CAPABILITY_TYPE	`4`
UNREGISTERED_CAPABILITY	`5`
INVALID_HANDLE	`6`

CapabilityType flexible

Type: uint32

Defined in fuchsia.component.runtime/capabilities.fidl

Added: HEAD

Name	Value	Description
CONNECTOR	`1`
DIR_CONNECTOR	`2`
DICTIONARY	`3`
DATA	`4`
CONNECTOR_ROUTER	`5`
DIR_CONNECTOR_ROUTER	`6`
DICTIONARY_ROUTER	`7`
DATA_ROUTER	`8`

RouterError flexible

Type: uint32

Defined in fuchsia.component.runtime/capabilities.fidl

The error values returned when a route operation fails.

Added: HEAD

Name	Value	Description
NOT_FOUND	`1`	The router failed to find the capability.
INVALID_ARGS	`2`	The arguments provided to the function are invalid.
NOT_SUPPORTED	`3`	The operation is not supported.
INTERNAL	`4`	An internal error occurred.
UNKNOWN	`5`	An unknown error occurred.

RouterResponse flexible

Type: uint32

Defined in fuchsia.component.runtime/factory.fidl

The error values returned when a route operation succeeds.

Added: HEAD

Name	Value	Description
SUCCESS	`1`	The server end has been connected to a valid object.
UNAVAILABLE	`2`	The capability was marked as unavailable.

TABLES

CapabilitiesDictionaryRemoveRequest resource

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Field	Type
1	`dictionary`	`handle<eventpair>`
2	`key`	`fuchsia.component.decl/name`
3	`value`	`handle<eventpair>`

CapabilitiesDirConnectorOpenRequest resource

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Field	Type
1	`dir_connector`	`handle<eventpair>`
2	`channel`	`server_end:fuchsia.io/Directory`
3	`rights`	`fuchsia.io/Flags`
4	`subdir`	`string:1024`

RouteRequest resource

Defined in fuchsia.component.runtime/capabilities.fidl

Contains metadata on how to route a capability, and a token representing the component that started the route.

The contents of metadata are data capabilities used by component manager to track things like the type of the route (e.g. protocol, storage, runner, ...), the rights on a directory route, and the scope on an event stream route. Generally an empty dictionary is safe to pass to component manager.

Either both fields must be set, or neither.

Added: HEAD

Ordinal	Field	Type	Description
1	`target`	`WeakInstanceToken`
2	`metadata`	`client_end:Dictionary`

UNIONS

Capabilities_ConnectorCreate_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_ConnectorCreate_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_ConnectorOpen_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_ConnectorOpen_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_ConnectorRouterCreate_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_ConnectorRouterCreate_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_ConnectorRouterRoute_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_ConnectorRouterRoute_Response`
2	`err`	`zx/Status`
3	`framework_err`	`internal`

Capabilities_DataCreate_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DataCreate_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DataGet_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Data`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DataRouterCreate_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DataRouterCreate_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DataRouterRoute_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DataRouterRoute_Response`
2	`err`	`zx/Status`
3	`framework_err`	`internal`

Capabilities_DictionaryCreate_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DictionaryCreate_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DictionaryGet_Result strict resource

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DictionaryGet_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DictionaryInsert_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DictionaryInsert_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DictionaryIterateKeys_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DictionaryIterateKeys_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DictionaryRemove_Result strict resource

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DictionaryRemove_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DictionaryRouterCreate_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DictionaryRouterCreate_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DictionaryRouterRoute_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DictionaryRouterRoute_Response`
2	`err`	`zx/Status`
3	`framework_err`	`internal`

Capabilities_DirConnectorCreate_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DirConnectorCreate_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DirConnectorOpen_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DirConnectorOpen_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DirConnectorRouterCreate_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DirConnectorRouterCreate_Response`
2	`err`	`CapabilitiesError`
3	`framework_err`	`internal`

Capabilities_DirConnectorRouterRoute_Result strict

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`Capabilities_DirConnectorRouterRoute_Response`
2	`err`	`zx/Status`
3	`framework_err`	`internal`

CapabilityDeprecated flexible resource

Defined in fuchsia.component.runtime/factory.fidl

A runtime capability in the component framework. These are the fundamental types used by component manager to implement capability routing and access control.

Each of these client ends is a reference to an object owned by component manager.

Added: HEAD

Ordinal	Variant	Type
1	`connector`	`client_end:Connector`
2	`dir_connector`	`client_end:DirConnector`
3	`dictionary`	`client_end:Dictionary`
4	`data`	`Data`
5	`connector_router`	`client_end:ConnectorRouterDeprecated`
6	`dir_connector_router`	`client_end:DirConnectorRouterDeprecated`
7	`dictionary_router`	`client_end:DictionaryRouterDeprecated`
8	`data_router`	`client_end:DataRouterDeprecated`

ConnectorRouterDeprecated_Route_Result strict resource

Defined in fuchsia.component.runtime/factory.fidl

Ordinal	Variant	Type
1	`response`	`ConnectorRouterDeprecated_Route_Response`
2	`err`	`RouterError`
3	`framework_err`	`internal`

ConnectorRouter_Route_Result strict resource

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`ConnectorRouter_Route_Response`
2	`err`	`RouterError`
3	`framework_err`	`internal`

Data flexible

Defined in fuchsia.component.runtime/capabilities.fidl

Static data which may be put in a dictionary or returned by a router. This is useful for setting values in the metadata of a RouteRequest.

Added: HEAD

Ordinal	Variant	Type
1	`bytes`	`vector<uint8>:8192`
2	`string`	`string:8192`
3	`int64`	`int64`
4	`uint64`	`uint64`

DataRouterDeprecated_Route_Result strict resource

Defined in fuchsia.component.runtime/factory.fidl

Ordinal	Variant	Type
1	`response`	`DataRouterDeprecated_Route_Response`
2	`err`	`RouterError`
3	`framework_err`	`internal`

DataRouter_Route_Result strict resource

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`DataRouter_Route_Response`
2	`err`	`RouterError`
3	`framework_err`	`internal`

DictionaryRouterDeprecated_Route_Result strict resource

Defined in fuchsia.component.runtime/factory.fidl

Ordinal	Variant	Type
1	`response`	`DictionaryRouterDeprecated_Route_Response`
2	`err`	`RouterError`
3	`framework_err`	`internal`

DictionaryRouter_Route_Result strict resource

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`DictionaryRouter_Route_Response`
2	`err`	`RouterError`
3	`framework_err`	`internal`

Dictionary_Get_Result strict resource

Defined in fuchsia.component.runtime/factory.fidl

Ordinal	Variant	Type	Description
1	`response`	`Dictionary_Get_Response`
3	`framework_err`	`internal`

Dictionary_LegacyExport_Result strict resource

Defined in fuchsia.component.runtime/factory.fidl

Ordinal	Variant	Type	Description
1	`response`	`Dictionary_LegacyExport_Response`
3	`framework_err`	`internal`

Dictionary_Remove_Result strict resource

Defined in fuchsia.component.runtime/factory.fidl

Ordinal	Variant	Type	Description
1	`response`	`Dictionary_Remove_Response`
3	`framework_err`	`internal`

DirConnectorRouterDeprecated_Route_Result strict resource

Defined in fuchsia.component.runtime/factory.fidl

Ordinal	Variant	Type
1	`response`	`DirConnectorRouterDeprecated_Route_Response`
2	`err`	`RouterError`
3	`framework_err`	`internal`

DirConnectorRouter_Route_Result strict resource

Defined in fuchsia.component.runtime/capabilities.fidl

Ordinal	Variant	Type
1	`response`	`DirConnectorRouter_Route_Response`
2	`err`	`RouterError`
3	`framework_err`	`internal`

CONSTANTS

Name	Value	Type	Description
MAX_DATA_LENGTH	`8192`	`uint32`	Added: HEAD