fuchsia.component.sandbox

Added: HEAD

PROTOCOLS

Dictionary

Defined in fuchsia.component.sandbox/sandbox.fidl

Clone2

Request

NameType
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

NameType
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

NameType
contents server_end<DictionaryIterator>?

Enumerate

Enumerates the entries in this dictionary.

Creates a clone of each item during enumeration.

Request

NameType
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

NameType
key DictionaryKey

Response

NameType
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

NameType
key DictionaryKey
value Capability

Response

NameType
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

NameType
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

NameType
key DictionaryKey

Response

NameType
payload Dictionary_Remove_Result

DictionaryIterator

Defined in fuchsia.component.sandbox/sandbox.fidl

GetNext

Request

<EMPTY>

Response

NameType
payload DictionaryIterator_GetNext_Result

Factory

Defined in fuchsia.component.sandbox/sandbox.fidl

Entrypoint for instantiation of sandbox types.

CreateConnector

Creates a connector (pair of Sender and Receiver).

Request

NameType
sender server_end<Sender>
receiver Receiver

CreateDictionary

Creates a Dictionary initialized with items.

Request

NameType
items vector<DictionaryItem>
server_end server_end<Dictionary>

Response

NameType
payload Factory_CreateDictionary_Result

CreateOpen

Creates an Open capability that issues Open calls on an another Openable.

This registers the Openable as a sandbox capability, represented by the client end peer of server_end.

Request

NameType
client_end fuchsia.io/Openable
server_end server_end<fuchsia.io/Openable>

Response

<EMPTY>

HandleCapability

Defined in fuchsia.component.sandbox/sandbox.fidl

Clone2

Request

NameType
request server_end<fuchsia.unknown/Cloneable>

GetHandle

Request

<EMPTY>

Response

NameType
payload HandleCapability_GetHandle_Result

Receiver

Defined in fuchsia.component.sandbox/sandbox.fidl

Clone2

Request

NameType
request server_end<fuchsia.unknown/Cloneable>

Receive

Receives a Capability.

Request

NameType
channel handle<channel>
flags fuchsia.io/OpenFlags

Sender

Defined in fuchsia.component.sandbox/sandbox.fidl

Clone2

Request

NameType
request server_end<fuchsia.unknown/Cloneable>

Send

Sends a Capability over this sender.

Request

NameType
channel handle<channel>
flags fuchsia.io/OpenFlags

STRUCTS

DictionaryItem resource

Defined in fuchsia.component.sandbox/sandbox.fidl

A key-value pair in a Dictionary.

FieldTypeDescriptionDefault
key DictionaryKey No default
value Capability No default

DictionaryIterator_GetNext_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

FieldTypeDescriptionDefault
items vector<DictionaryItem>[128] No default

Dictionary_Get_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

FieldTypeDescriptionDefault
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

FieldTypeDescriptionDefault
items vector<DictionaryItem> No default

Dictionary_Remove_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

FieldTypeDescriptionDefault
capability Capability No default

Factory_CreateDictionary_Response

Defined in fuchsia.component.sandbox/sandbox.fidl

<EMPTY>

HandleCapability_GetHandle_Response resource

Defined in fuchsia.component.sandbox/sandbox.fidl

FieldTypeDescriptionDefault
handle handle<handle> No default

OptionalCapability resource

Defined in fuchsia.component.sandbox/sandbox.fidl

FieldTypeDescriptionDefault
value Capability? No default

ProtocolPayload resource

Defined in fuchsia.component.sandbox/sandbox.fidl

Contains a protocol open request.

FieldTypeDescriptionDefault
channel handle<channel> No default
flags fuchsia.io/OpenFlags 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.

NameValueDescription
1

The Dictionary does not contain an item with the given key.

2

The Dictionary already contains an item with the given key.

3

The Capability is invalid.

Capabilites must be created by sandbox, via fuchsia.component.sandbox.Factory or returned from other Component Framework APIs.

HandleCapabilityError strict

Type: uint32

Defined in fuchsia.component.sandbox/sandbox.fidl

NameValueDescription
1

UNIONS

Capability flexible resource

Defined in fuchsia.component.sandbox/sandbox.fidl

OrdinalVariantTypeDescription
unit UnitCapability
opaque handle<event>
handle HandleCapability
data DataCapability
cloneable fuchsia.unknown/Cloneable
dictionary Dictionary
sender Sender
receiver server_end<Receiver>
open fuchsia.io/Openable
directory fuchsia.io/Directory
optional OptionalCapability

DataCapability flexible

Defined in fuchsia.component.sandbox/sandbox.fidl

OrdinalVariantTypeDescription
bytes vector<uint8>[8192]
string string[8192]
int64 int64
uint64 uint64

DictionaryIterator_GetNext_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

OrdinalVariantTypeDescription
response DictionaryIterator_GetNext_Response
framework_err internal

Dictionary_Get_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

OrdinalVariantTypeDescription
response Dictionary_Get_Response
err DictionaryError
framework_err internal

Dictionary_Insert_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

OrdinalVariantTypeDescription
response Dictionary_Insert_Response
err DictionaryError
framework_err internal

Dictionary_Read_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

OrdinalVariantTypeDescription
response Dictionary_Read_Response
framework_err internal

Dictionary_Remove_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

OrdinalVariantTypeDescription
response Dictionary_Remove_Response
err DictionaryError
framework_err internal

Factory_CreateDictionary_Result strict

Defined in fuchsia.component.sandbox/sandbox.fidl

OrdinalVariantTypeDescription
response Factory_CreateDictionary_Response
err DictionaryError
framework_err internal

HandleCapability_GetHandle_Result strict resource

Defined in fuchsia.component.sandbox/sandbox.fidl

OrdinalVariantTypeDescription
response HandleCapability_GetHandle_Response
err HandleCapabilityError

CONSTANTS

NameValueTypeDescription
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].

ALIASES

NameValueDescription
DictionaryKey string[fidl/MAX]

The key of a DictionaryItem.