fuchsia.component.sandbox

PROTOCOLS

Dict

Defined in fuchsia.component.sandbox/sandbox.fidl

Insert

Inserts a key-value pair into the dict.

• error DictError.ALREADY_EXISTS if the dict already contains an item with the same key.

Request

Name	Type
key	DictKey
value	Capability

Response

Name	Type
payload	Dict_Insert_Result

Read

Returns all items in this dict. Requires that all capabilities in the dict are cloneable. This will clone each capability in the dict and return handles to the cloned capabilities.

• error DictError.NOT_CLONEABLE if any of the capabilities in the dict could not be cloned.

Request

<EMPTY>

Response

Name	Type
payload	Dict_Read_Result

Remove

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

• error DictError.NOT_FOUND if the dict does not contain the key.

Request

Name	Type
key	DictKey

Response

Name	Type
payload	Dict_Remove_Result

Factory

Defined in fuchsia.component.sandbox/sandbox.fidl

Entrypoint for instantiation of sandbox types.

CreateConnector

Create a connector (pair of Sender and Receiver).

Request

Name	Type
sender	server_end<Sender>
receiver	Receiver

CreateDict

Create a dictionary initialized with items.

Request

Name	Type
items	vector<DictItem>
server_end	server_end<Dict>

Response

Name	Type
payload	Factory_CreateDict_Result

Receiver

Defined in fuchsia.component.sandbox/sandbox.fidl

Receive

Receives a single Capability handle.

Request

Name	Type
capability	Capability

Sender

Defined in fuchsia.component.sandbox/sandbox.fidl

Send

Sends a single Capability handle over this sender.

Request

Name	Type
capability	Capability

Response

Name	Type
payload	Sender_Send_Result

STRUCTS

DictItem resource

Defined in fuchsia.component.sandbox/sandbox.fidl

A key-value pair in a Dict.

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

Dict_Insert_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

Dict_Read_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
items	vector<DictItem>		No default

Dict_Remove_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Field	Type	Description	Default
capability	Capability		No default

Factory_CreateDict_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

Sender_Send_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

ENUMS

DictError flexible

Type: uint32

Defined in fuchsia.component.sandbox/sandbox.fidl

Error returned from methods in Dict.

Name	Value	Description
NOT_FOUND	1	The Dict does not contain an item with the given key.
ALREADY_EXISTS	2	The Dict already contains an item with the given key.
BAD_HANDLE	3	The Capability handle was invalid.
NOT_CLONEABLE	4	A capability could not be cloned.

SenderError flexible

Type: uint32

Defined in fuchsia.component.sandbox/sandbox.fidl

Name	Value	Description
BAD_HANDLE	1	The Capability handle was invalid.

UNIONS

Dict_Insert_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Dict_Insert_Response
2	err	DictError

Dict_Read_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Dict_Read_Response
2	err	DictError

Dict_Remove_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Dict_Remove_Response
2	err	DictError

Factory_CreateDict_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Factory_CreateDict_Response
2	err	DictError

Sender_Send_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

Ordinal	Variant	Type	Description
1	response	Sender_Send_Response
2	err	SenderError

ALIASES

Name	Value	Description
Capability	zx/Handle	A capability of unknown type.
DictKey	string[fidl/MAX]	The key of a DictItem.