fuchsia.component.sandbox

PROTOCOLS

CapabilityStore

Defined in fuchsia.component.sandbox/sandbox.fidl

Protocol that represents the concept of a "capability store", a repository for [Capability]s that are held by the component framework runtime.

[CapabilityStore] serves as the main bridge between the component runtime and clients that enables them to operate on and exchange [Capability]s. A [CapabilityStore] instance contains a set of [Capability]s, each of which has a [CapabilityId] assigned by the client.

Normally, a program would not exchange a [CapabilityStore] or [CapabilityId] with other programs -- a [CapabilityStore] connection and its enclosed capabilities are intended to be "local" to a program. Instead, if a program wishes to exchange a [Capability] with other programs, it should [Export] the [Capability] out of the store, send the [Capability] to the target program, which can then [Import] the capability into its own store.

[CapabilityStore] is also used to manage capability lifetimes. The lifetime of a capability is scoped to the [CapabilityStore] in which it resides; i.e. to drop the [CapabilityStore] connections to release the capabilities instead it. In addition, [CapabilityStore] supports a [Drop] API to drop an individual [Capability] reference. (Note that it is possible for a some capabilities, like [DictionaryRef], to have multiple references, in which case all of the references must be dropped for the underlying resource to be released.)

A note about semantics: the [CapabilityStore] APIs do not return [CapabilityId]s, because [CapabilityId]s are assigned by the client. Instead, when a method would semantically return a capability, this is expressed by taking the destination [CapabilityId] as an output parameter.

ConnectorCreate

Creates a [Connector] from a [Receiver]. Incoming connections to the [Connector] will be dispatched to this [Receiver].

Errors:

• ID_ALREADY_EXISTS if a capability with id already exists in this store.

Request

Name	Type
id	NewCapabilityId
receiver	client_end:Receiver

Response

Name	Type
payload	CapabilityStore_ConnectorCreate_Result

ConnectorOpen

Open a connection from the provided [Connector] capability that will be dispatched to the [Receiver] on the other end.

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

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.
• WRONG_TYPE if id was not a connector capability.

Request

Name	Type
id	CapabilityId
server_end	handle<channel>

Response

Name	Type
payload	CapabilityStore_ConnectorOpen_Result

DictionaryCopy

Create a new dictionary that contains a duplicate of all the entries in the dictionary with id, assigning dest_id to the new dictionary. The runtime of this method is linear in the number of top-level entries in the dictionary.

For example, if the dictionary contains nested dictionaries, the newly created dictionary will contain references to those same nested dictionaries because the entries are duplicated rather than deep-copied.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.
• ID_ALREADY_EXISTS if a capability with dest_id already exists in this store.
• WRONG_TYPE if id was not a dictionary.
• NOT_DUPLICATABLE if one of the capabilities in id could not be duplicated.

Request

Name	Type
id	CapabilityId
dest_id	NewCapabilityId

Response

Name	Type
payload	CapabilityStore_DictionaryCopy_Result

DictionaryCreate

Creates a new empty dictionary in this CapabilityStore with client-assigned id.

Errors:

• ID_ALREADY_EXISTS if a capability with id already exists in this store.

Request

Name	Type
id	CapabilityId

Response

Name	Type
payload	CapabilityStore_DictionaryCreate_Result

DictionaryDrain

Removes all the entries in this dictionary, returning them in contents if provided. If contents is not provided, all the items are discarded without enumerating them.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.
• WRONG_TYPE if id was not a dictionary.

Request

Name	Type
id	CapabilityId
iterator	server_end:DictionaryDrainIterator?

Response

Name	Type
payload	CapabilityStore_DictionaryDrain_Result

DictionaryEnumerate

Enumerates the items (keys and values) in the dictionary with id.

Creates a duplicate of each value (capability). If a value could not be duplicated, the value will be null.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.
• WRONG_TYPE if id was not a dictionary.

Request

Name	Type
id	CapabilityId
iterator	server_end:DictionaryEnumerateIterator

Response

Name	Type
payload	CapabilityStore_DictionaryEnumerate_Result

DictionaryGet

Get a duplicate of a capability from the dictionary with id, which is loaded into dest_id.

Errors:

• ID_NOT_FOUND if id was not a recognized capability id in this store.
• ID_ALREADY_EXISTS if a capability with dest_id already exists in this store.
• WRONG_TYPE if id was not a dictionary.
• INVALID_KEY if item.key was invalid.
• ITEM_NOT_FOUND if the dictionary does not contain key.
• NOT_DUPLICATABLE if the capability could not be duplicated.

Request

Name	Type
id	CapabilityId
key	DictionaryKey
dest_id	NewCapabilityId

Response

Name	Type
payload	CapabilityStore_DictionaryGet_Result

DictionaryInsert

Inserts item into the dictionary with id. item.value is moved into the dictionary and its id is released if this call succeeds.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.
• WRONG_TYPE if id was not a dictionary.
• INVALID_KEY if item.key was invalid.
• ITEM_ALREADY_EXISTS if the dictionary already contains an item with item.key.

Request

Name	Type
id	CapabilityId
item	DictionaryItem

Response

Name	Type
payload	CapabilityStore_DictionaryInsert_Result

DictionaryKeys

Enumerates the keys in the dictionary with id.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.
• WRONG_TYPE if id was not a dictionary.

Request

Name	Type
id	CapabilityId
iterator	server_end:DictionaryKeysIterator

Response

Name	Type
payload	CapabilityStore_DictionaryKeys_Result

DictionaryLegacyExport

Binds a channel to the dictionary with id. The channel can be re-imported into a [CapabilityStore] with [DictionaryImportLegacy].

This is a legacy API to support backward compatibility with APIs that take a [Dictionary] channel.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.

Request

Name	Type
id	CapabilityId
server_end	handle<channel>

Response

Name	Type
payload	CapabilityStore_DictionaryLegacyExport_Result

DictionaryLegacyImport

Imports a dictionary in the form of a channel.

This is a legacy API to support backward compatibility with APIs that take a [Dictionary] channel.

Errors:

• ID_ALREADY_EXISTS if a capability with id already exists in this store.
• BAD_CAPABILITY if client_end was not a valid dictionary channel.

Request

Name	Type
id	NewCapabilityId
client_end	handle<channel>

Response

Name	Type
payload	CapabilityStore_DictionaryLegacyImport_Result

DictionaryRemove

Removes a key from the dictionary with id. If dest_id is present, loads the value into it, otherwise discards the value.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.
• ID_ALREADY_EXISTS if a capability with dest_id already exists in this store.
• WRONG_TYPE if id was not a dictionary.
• INVALID_KEY if key was invalid.
• ITEM_NOT_FOUND if the dictionary does not contain the key.

Request

Name	Type
id	CapabilityId
key	DictionaryKey
dest_id	WrappedCapabilityId?

Response

Name	Type
payload	CapabilityStore_DictionaryRemove_Result

DirConnectorCreate

Creates a [DirConnector] from a [DirReceiver]. Incoming connections to the [DirConnector] will be dispatched to this [DirReceiver].

Errors:

• ID_ALREADY_EXISTS if a capability with id already exists in this store.

Request

Name	Type
id	NewCapabilityId
receiver	client_end:DirReceiver

Response

Name	Type
payload	CapabilityStore_DirConnectorCreate_Result

DirConnectorOpen

Open a connection from the provided [DirConnector] capability that will be dispatched to the [DirReceiver] on the other end.

This method does not take Open/Open3 parameters such as flags or path. Clients that wish to specify these can get an initial connection from this method and call fuchsia.io/Directory.Open on it. See the [DirReceiver] documentation for more information about the expectations of the server side.

If there was an error making the connection, it will be reported as a zx.Status epitaph on server_end.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.
• WRONG_TYPE if id was not a connector capability.

Request

Name	Type
id	CapabilityId
server_end	server_end:fuchsia.io/Directory

Response

Name	Type
payload	CapabilityStore_DirConnectorOpen_Result

Drop

Drops the capability with id from this CapabilityStore.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.

Request

Name	Type
id	CapabilityId

Response

Name	Type
payload	CapabilityStore_Drop_Result

Duplicate

Duplicates the capability with id to dest_id.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.
• ID_ALREADY_EXISTS if a capability with dest_id already exists in this store.
• NOT_DUPLICATABLE if id could not be duplicated.

Request

Name	Type
id	CapabilityId
dest_id	NewCapabilityId

Response

Name	Type
payload	CapabilityStore_Duplicate_Result

Export

Exports the capability with the client-assigned identifier id to capability. This operation removes the capability from the store. If this is not desired, [Duplicate] the capability first.

Errors:

• ID_NOT_FOUND if id was not a valid capability id in this store.

Request

Name	Type
id	CapabilityId

Response

Name	Type
payload	CapabilityStore_Export_Result

Import

Imports capability into this store with the client-assigned id.

Errors:

• ID_ALREADY_EXISTS if a capability with id already exists in this store.
• BAD_CAPABILITY if capability was not a valid [Capability].

Request

Name	Type
id	NewCapabilityId
capability	Capability

Response

Name	Type
payload	CapabilityStore_Import_Result

ConnectorRouter

Defined in fuchsia.component.sandbox/sandbox.fidl

Route

Request

Name	Type
payload	RouteRequest

Response

Name	Type
payload	ConnectorRouter_Route_Result

DataRouter

Defined in fuchsia.component.sandbox/sandbox.fidl

Route

Request

Name	Type
payload	RouteRequest

Response

Name	Type
payload	DataRouter_Route_Result

Dictionary

Defined in fuchsia.component.sandbox/sandbox.fidl

DictionaryDrainIterator

Defined in fuchsia.component.sandbox/sandbox.fidl

GetNext

Returns the next batch of results for a [Dictionary.Drain] call, returning up to limit results. limit can be at most [MAX_DICTIONARY_ITERATOR_CHUNK].

Each returned capability will be assigned a monotonically increasing [CapabilityId] starting from start_id.

In addition to the items, returns end_id, which is one more than the highest id reserved by [GetNext]. end_id can be used as the start_id for the next call to [GetNext].

If [GetNext] returns an error, the server will also close the channel.

Errors:

• ID_ALREADY_EXISTS if some id in the range [start_id, limit) already exists in this store.
• INVALID_ARGS if limit was 0 or greater than MAX_DICTIONARY_ITERATOR_CHUNK.

Request

Name	Type
start_id	CapabilityId
limit	uint32

Response

Name	Type
payload	DictionaryDrainIterator_GetNext_Result

DictionaryEnumerateIterator

Defined in fuchsia.component.sandbox/sandbox.fidl

GetNext

Returns the next batch of results for a [Dictionary.Enumerate] call, returning up to limit results. limit can be at most [MAX_DICTIONARY_ITERATOR_CHUNK].

The value of each of items is a duplicate of the original capability ([CapabilityStore.Duplicate]), unless it could not be duplicated, it which case it will be null.

Each returned capability will be assigned a monotonically increasing [CapabilityId] starting from start_id.

In addition to the items, returns end_id, which is one more than the highest id reserved by [GetNext]. end_id can be used as the start_id for the next call to [GetNext].

If [GetNext] returns an error, the server will also close the channel.

Errors:

• ID_ALREADY_EXISTS if some id in the range [start_id, limit) already exists in this store.
• INVALID_ARGS if limit was 0 or greater than MAX_DICTIONARY_ITERATOR_CHUNK.

Request

Name	Type
start_id	CapabilityId
limit	uint32

Response

Name	Type
payload	DictionaryEnumerateIterator_GetNext_Result

DictionaryKeysIterator

Defined in fuchsia.component.sandbox/sandbox.fidl

GetNext

Request

<EMPTY>

Response

Name	Type
payload	DictionaryKeysIterator_GetNext_Result

DictionaryRouter

Defined in fuchsia.component.sandbox/sandbox.fidl

Route

Request

Name	Type
payload	RouteRequest

Response

Name	Type
payload	DictionaryRouter_Route_Result

DirConnectorRouter

Defined in fuchsia.component.sandbox/sandbox.fidl

Route

Request

Name	Type
payload	RouteRequest

Response

Name	Type
payload	DirConnectorRouter_Route_Result

DirEntryRouter

Defined in fuchsia.component.sandbox/sandbox.fidl

Route

Request

Name	Type
payload	RouteRequest

Response

Name	Type
payload	DirEntryRouter_Route_Result

DirReceiver

Defined in fuchsia.component.sandbox/sandbox.fidl

A receiver is served by components and allows them to receive directory channels framework.

Receive

Sends a directory channel to this receiver.

The server should implement this method by forwarding channel to a vfs instance of the language appropriate vfs library. To keep this interface decoupled from fuchsia.io, it deliberately omits Open/Open3 parameters such as flags and path. If a client wishes to specify these, they can obtain an initial [fuchsia.io/Directory] channel first and then call Open/Open3 on it.

Request

Name	Type
channel	server_end:fuchsia.io/Directory

DirectoryRouter

Defined in fuchsia.component.sandbox/sandbox.fidl

Route

Request

Name	Type
payload	RouteRequest

Response

Name	Type
payload	DirectoryRouter_Route_Result

Receiver

Defined in fuchsia.component.sandbox/sandbox.fidl

A receiver is served by components and allows them to receive channels from the framework.

Receive

Sends a channel to this receiver.

Request

Name	Type
channel	handle<channel>

STRUCTS

CapabilityStore_ConnectorCreate_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_ConnectorOpen_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryCopy_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryCreate_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryDrain_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryEnumerate_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryGet_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryInsert_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryKeys_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryLegacyExport_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryLegacyImport_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DictionaryRemove_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DirConnectorCreate_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_DirConnectorOpen_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_Drop_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_Duplicate_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

CapabilityStore_Export_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
capability	Capability		No default

CapabilityStore_Import_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

Connector resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
token	Token		No default

DictionaryDrainIterator_GetNext_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
items	vector<DictionaryItem>:128		No default
end_id	CapabilityId		No default

DictionaryEnumerateIterator_GetNext_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
items	vector<DictionaryOptionalItem>:128		No default
end_id	CapabilityId		No default

DictionaryItem

Defined in fuchsia.component.sandbox/sandbox.fidl

A key-value pair in a DictionaryRef.

Field	Type	Description	Default
key	DictionaryKey		No default
value	CapabilityId		No default

DictionaryKeysIterator_GetNext_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
keys	vector<DictionaryKey>:128		No default

DictionaryOptionalItem resource

Defined in fuchsia.component.sandbox/sandbox.fidl

A key-value pair in a DictionaryRef, where the value may be elided. This is useful for APIs that may wish to omit the value, for example if it could not be duplicated.

Field	Type	Description	Default
key	DictionaryKey		No default
value	WrappedCapabilityId?		No default

DictionaryRef resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
token	Token		No default

DirConnector resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
token	Token		No default

DirEntry resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
token	Token		No default

InstanceToken resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Represents an instance in the component tree, either a component instance or component manager's instance.

Field	Type	Description	Default
token	Token		No default

ProtocolPayload resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Contains a protocol open request.

Field	Type	Description	Default
channel	handle<channel>		No default

Unavailable

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

Unit

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

WrappedCapabilityId

Defined in fuchsia.component.sandbox/sandbox.fidl

A [CapabilityId] wrapped in a struct. This is useful for putting a [CapabilityId] in a box<>, which FIDL does not allow for pure integral types.

Field	Type	Description	Default
id	CapabilityId		No default

ENUMS

Availability strict

Type: uint32

Defined in fuchsia.component.sandbox/availability.fidl

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).

Name	Value	Description
REQUIRED	1	The capability must be available. Failure to route the capability is an error.
OPTIONAL	2	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.
SAME_AS_TARGET	3	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.
TRANSITIONAL	4	The source may omit the route completely without even having to route from void. TRANSITIONAL is used for soft transitions that introduce new capabilities.

CapabilityStoreError flexible

Type: uint32

Defined in fuchsia.component.sandbox/sandbox.fidl

Error returned from methods in [CapabilityStore].

Name	Value	Description
ID_NOT_FOUND	1	A capability was not found matching the given key or [CapabilityId].
ID_ALREADY_EXISTS	2	A capability already exists matching the given key or [CapabilityId].
BAD_CAPABILITY	3	A [Capability] was not valid. For example, a Capability.Dictionary contained an invalid [DictionaryRef].
WRONG_TYPE	4	A [CapabilityId] had the wrong type for the requested operation.
NOT_DUPLICATABLE	5	A capability that needed to be duplicated to perform this operation could not be.
ITEM_NOT_FOUND	6	An item in a dictionary was not found matching the given key.
ITEM_ALREADY_EXISTS	7	An item in a dictionary already exists with the given key.
INVALID_KEY	8	The key is invalid. The constraints for valid keys are documented at https://fuchsia.dev/reference/cml#names.
INVALID_ARGS	9	One or more arguments were invalid.

DictionaryError flexible

Type: uint32

Defined in fuchsia.component.sandbox/sandbox.fidl

Error returned from [CapabilityStore/Dictionary*] methods.

Name	Value	Description
NOT_FOUND	1	The Dictionary does not contain an item with the given key.
ALREADY_EXISTS	2	The Dictionary already contains an item with the given key.
BAD_CAPABILITY	3	The Capability is invalid. Capabilities must be created by sandbox, via fuchsia.component.sandbox/CapabilityStore or returned from other Component Framework APIs.
INVALID_KEY	4	The key is invalid. The constraints for valid keys are documented at https://fuchsia.dev/reference/cml#names.
NOT_CLONEABLE	5	A capability that needed to be cloned to perform this operation could not be cloned.

RouterError flexible

Type: uint32

Defined in fuchsia.component.sandbox/sandbox.fidl

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.

TABLES

RouteRequest resource

Defined in fuchsia.component.sandbox/sandbox.fidl

A request for a route.

Ordinal	Field	Type	Description
1	requesting	InstanceToken	The component that is requesting the capability. May be omitted for a default request (see *Router.Route).
2	metadata	DictionaryRef	Metadata associated with this capability request. May be omitted for a default request (see *Router.Route).

UNIONS

Capability flexible resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	unit	Unit
2	handle	handle<handle>
3	data	Data
4	dictionary	DictionaryRef
5	connector	Connector
6	dir_connector	DirConnector
7	directory	client_end:fuchsia.io/Directory
8	dir_entry	DirEntry
9	connector_router	client_end:ConnectorRouter
10	dictionary_router	client_end:DictionaryRouter
11	dir_entry_router	client_end:DirEntryRouter
12	data_router	client_end:DataRouter
13	dir_connector_router	client_end:DirConnectorRouter

CapabilityStore_ConnectorCreate_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_ConnectorCreate_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_ConnectorOpen_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_ConnectorOpen_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryCopy_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryCopy_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryCreate_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryCreate_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryDrain_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryDrain_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryEnumerate_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryEnumerate_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryGet_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryGet_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryInsert_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryInsert_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryKeys_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryKeys_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryLegacyExport_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryLegacyExport_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryLegacyImport_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryLegacyImport_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DictionaryRemove_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DictionaryRemove_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DirConnectorCreate_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DirConnectorCreate_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_DirConnectorOpen_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_DirConnectorOpen_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_Drop_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_Drop_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_Duplicate_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_Duplicate_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_Export_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_Export_Response
2	err	CapabilityStoreError
3	framework_err	internal

CapabilityStore_Import_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	CapabilityStore_Import_Response
2	err	CapabilityStoreError
3	framework_err	internal

ConnectorRouter_Route_Response strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	connector	Connector
2	unavailable	Unit

ConnectorRouter_Route_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

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

Data flexible

Defined in fuchsia.component.sandbox/sandbox.fidl

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

DataRouter_Route_Response strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	data	Data
2	unavailable	Unit

DataRouter_Route_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

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

DictionaryDrainIterator_GetNext_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	DictionaryDrainIterator_GetNext_Response
2	err	CapabilityStoreError
3	framework_err	internal

DictionaryEnumerateIterator_GetNext_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	DictionaryEnumerateIterator_GetNext_Response
2	err	CapabilityStoreError
3	framework_err	internal

DictionaryKeysIterator_GetNext_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	DictionaryKeysIterator_GetNext_Response
3	framework_err	internal

DictionaryRouter_Route_Response strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	dictionary	DictionaryRef
2	unavailable	Unit

DictionaryRouter_Route_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

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

DirConnectorRouter_Route_Response strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	dir_connector	DirConnector
2	unavailable	Unit

DirConnectorRouter_Route_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

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

DirEntryRouter_Route_Response strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	dir_entry	DirEntry
2	unavailable	Unit

DirEntryRouter_Route_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	DirEntryRouter_Route_Response
2	err	RouterError
3	framework_err	internal

DirectoryRouter_Route_Response strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	directory	client_end:fuchsia.io/Directory
2	unavailable	Unit

DirectoryRouter_Route_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	DirectoryRouter_Route_Response
2	err	RouterError
3	framework_err	internal

CONSTANTS

Name	Value	Type	Description
MAX_DATA_LENGTH	8192	uint32	Maximum number of bytes in a [Data]. Added: HEAD
MAX_DICTIONARY_ITERATOR_CHUNK	128	uint32	Maximum number of items returned by dictionary iterator. Added: HEAD
MAX_NAME_LENGTH	fuchsia.io/MAX_NAME_LENGTH	uint64	The maximum length of a dictionary key. This should coincide with fuchsia.component.MAX_NAME_LENGTH. Added: HEAD

ALIASES

Name	Value	Description
CapabilityId	uint64	A client-assigned id of a [Capability] in a [CapabilityStore]. The id is relative to the [CapabilityStore]. In the case where two [CapabilityStore]s have a capability / assigned to the same id, there is no relation between them Added: HEAD
DictionaryKey	string[MAX_NAME_LENGTH]	The key of a DictionaryItem. The constraints for valid keys are documented at https://fuchsia.dev/reference/cml#names. Added: HEAD
NewCapabilityId	uint64	A client-assigned id of a new [Capability] in a [CapabilityStore]. Same as [CapabilityId], but used to distinguish output parameters in [CapabilityStore] methods. Added: HEAD
Token	zx/Handle	A token represents a bedrock object. Tokens are reference counted, dropping all counts of the token removes the object. Added: HEAD
WrappedNewCapabilityId	fuchsia.component.sandbox/WrappedCapabilityId	Added: HEAD