fuchsia.component.sandbox

PROTOCOLS

Dictionary

Defined in fuchsia.component.sandbox/sandbox.fidl

Clone2

Request

Name	Type
request	server_end<fuchsia.unknown/Cloneable>

Copy

Create a new dictionary that contains a clone of all the entries in this dictionary.

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

Request

Name	Type
request	server_end<Dictionary>

Drain

Removes all the entries in this dictionary.

If contents is not provided, all the items are discarded without enumerating them.

Request

Name	Type
contents	server_end<DictionaryIterator>?

Enumerate

Enumerates the entries in this dictionary.

Creates a clone of each item during enumeration.

Request

Name	Type
contents	server_end<DictionaryIterator>

Get

Get a clone of a capability from this dictionary.

• error DictionaryError.NOT_FOUND if the dictionary does not contain the key.

Request

Name	Type
key	DictionaryKey

Response

Name	Type
payload	Dictionary_Get_Result

Insert

Inserts a key-value pair into the dictionary.

• error DictionaryError.ALREADY_EXISTS if the dictionary already contains an item with the same key.

Request

Name	Type
key	DictionaryKey
value	Capability

Response

Name	Type
payload	Dictionary_Insert_Result

Read

Returns all items in this dictionary, sorted by key in natural order.

This operation creates shallow clones of values.

Request

<EMPTY>

Response

Name	Type
payload	Dictionary_Read_Result

Remove

Removes a key from the dictionary, returning the Capability value.

• error DictionaryError.NOT_FOUND if the dictionary does not contain the key.

Request

Name	Type
key	DictionaryKey

Response

Name	Type
payload	Dictionary_Remove_Result

DictionaryIterator

Defined in fuchsia.component.sandbox/sandbox.fidl

GetNext

Request

<EMPTY>

Response

Name	Type
payload	DictionaryIterator_GetNext_Result

Factory

Defined in fuchsia.component.sandbox/sandbox.fidl

Entrypoint for instantiation of sandbox types.

CreateDictionary

Creates a new empty Dictionary.

Request

<EMPTY>

Response

Name	Type
payload	Factory_CreateDictionary_Result

CreateDirectory

Creates a Directory capability from a client_end:fuchsia.io.Directory, and registers it as a sandbox capability.

Request

Name	Type
client_end	fuchsia.io/Directory

Response

Name	Type
payload	Factory_CreateDirectory_Result

CreateSender

Creates a Sender from a client served Receiver.

Request

Name	Type
receiver	Receiver

Response

Name	Type
payload	Factory_CreateSender_Result

HandleCapability

Defined in fuchsia.component.sandbox/sandbox.fidl

Clone2

Request

Name	Type
request	server_end<fuchsia.unknown/Cloneable>

GetHandle

Request

<EMPTY>

Response

Name	Type
payload	HandleCapability_GetHandle_Result

Receiver

Defined in fuchsia.component.sandbox/sandbox.fidl

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

Receive

Sends a channel to this receiver.

Request

Name	Type
channel	handle<channel>

Sender

Defined in fuchsia.component.sandbox/sandbox.fidl

A sender allows a client to send a channel to the framework so that it can be connected.

Clone2

Request

Name	Type
request	server_end<fuchsia.unknown/Cloneable>

Send

Sends a channel over this sender.

Request

Name	Type
channel	handle<channel>

STRUCTS

DictionaryItem resource

Defined in fuchsia.component.sandbox/sandbox.fidl

A key-value pair in a Dictionary.

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

DictionaryIterator_GetNext_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
items	vector<DictionaryItem>[128]		No default

Dictionary_Get_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
capability	Capability		No default

Dictionary_Insert_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

Dictionary_Read_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
items	vector<DictionaryItem>		No default

Dictionary_Remove_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
capability	Capability		No default

Factory_CreateDictionary_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
dictionary	Dictionary		No default

Factory_CreateDirectory_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
capability	Capability		No default

Factory_CreateSender_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
sender	Sender		No default

HandleCapability_GetHandle_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
handle	handle<handle>		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

UnitCapability

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

ENUMS

DictionaryError flexible

Type: uint32

Defined in fuchsia.component.sandbox/sandbox.fidl

Error returned from methods in Dictionary.

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. Capabilites must be created by sandbox, via fuchsia.component.sandbox.Factory 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.

HandleCapabilityError strict

Type: uint32

Defined in fuchsia.component.sandbox/sandbox.fidl

Name	Value	Description
UNAVAILABLE	1

UNIONS

Capability flexible resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	unit	UnitCapability
2	handle	HandleCapability
3	data	DataCapability
4	cloneable	fuchsia.unknown/Cloneable
5	dictionary	Dictionary
6	sender	Sender
7	directory	fuchsia.io/Directory

DataCapability 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

DictionaryIterator_GetNext_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	DictionaryIterator_GetNext_Response
3	framework_err	internal

Dictionary_Get_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Dictionary_Get_Response
2	err	DictionaryError
3	framework_err	internal

Dictionary_Insert_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Dictionary_Insert_Response
2	err	DictionaryError
3	framework_err	internal

Dictionary_Read_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Dictionary_Read_Response
3	framework_err	internal

Dictionary_Remove_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Dictionary_Remove_Response
2	err	DictionaryError
3	framework_err	internal

Factory_CreateDictionary_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Factory_CreateDictionary_Response
3	framework_err	internal

Factory_CreateDirectory_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Factory_CreateDirectory_Response
3	framework_err	internal

Factory_CreateSender_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Factory_CreateSender_Response
3	framework_err	internal

HandleCapability_GetHandle_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	HandleCapability_GetHandle_Response
2	err	HandleCapabilityError

CONSTANTS

Name	Value	Type	Description
MAX_DATA_LENGTH	8192	uint32	Maximum number of bytes in a [DataCapability].
MAX_DICTIONARY_ITEMS_CHUNK	128	uint32	Maximum number of items returned by [DictionaryIterator].
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
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